mirror of
https://github.com/J3vb/OwnCord.git
synced 2026-09-03 03:50:00 +03:00
`Server/go.mod` declared `github.com/owncord/server` while the public repository is `github.com/J3vb/OwnCord`. Nothing resolves that path — there is no `owncord` GitHub org and no vanity-import host serving go-import metadata for it — so every import line in the tree named a location that does not exist. It compiles because a main module's own path is never fetched, which is exactly why it went unnoticed. The obvious fix — an AST-aware import rewriter (`gomvpkg`, `go mod edit`) — is wrong here, and provably so. Six of the 722 occurrences are not imports at all: `api/main_test.go:20` (a goleak `IgnoreTopFunction` pattern), `telemetry/metrics.go:17-19` (three OTel instrumentation-scope names), `invariants/syncutil_locks.go:73` (a diagnostic message), and `invariants/syncutil_locks_test.go:56` (an import line inside a raw-string Go fixture). An import rewriter touches none of them, and the compiler cannot see any of them either. Done as one scripted substitution over `git ls-files`, anchored on the full `github.com/owncord/server` string. The anchor matters: `owncord-server` is a different identifier — the OTel `service.name` (`config/config.go`, `telemetry/telemetry_otel.go`) and the GHCR image name (`.github/workflows/release.yml`, `docker-compose.yml`) — and a looser pattern would have moved it. It is untouched: 10 occurrences across 9 files, before and after. 350 files, 728 insertions, 728 deletions. 722 occurrences in 344 Go files, plus `go.mod:1`, the `sed` at `Makefile:67`, `Server/CLAUDE.md:3`, `docs/architecture/server.md:5`, and the ledger pair (`findings-ledger.json:3758` plus a `render-ledger.mjs` re-render of `FINDINGS.md`). Zero in any workflow, zero in the Dockerfile, zero in `Server/.golangci.yml` (no `local-prefixes`, `gci`, `importas` or `depguard` rule keys on the module path, so import grouping is not configured anywhere). The plan's blast-radius estimate missed one thing, and it is the one that would have gone red: **gofmt**. `J` (0x4A) sorts before every lowercase letter, so in the 36 files where a module-local import shares a contiguous group with a third-party one, the module's imports must move above `github.com/go-chi/...`. `gofmt -l` was clean before the substitution and listed exactly 36 files after it; `gofmt -w` on those 36 restores it to clean. `gofmt` is an enforced gate — the `formatters` block in `Server/.golangci.yml`, which is S-05 — so a substitution-only commit fails Lint. Verified: both directions, and the line accounting is exact. Every added line in this diff contains the new module path (728) and every removed line contains the old one (728); the count of changed lines containing neither is **zero**, so the gofmt re-sort moved module-path lines only and touched no third-party import. The residual check (`git ls-files -z | xargs -0 grep -n 'github\.com/owncord/server'`) returns exactly two hits, both deliberately out of scope: the RL-13 row in `docs/audit-2026-08-23-repository-layout.md` and the measurement row in this phase's own plan. The compiler-invisible half was proven by reverting *only* `api/main_test.go:20` to the old path on the otherwise-renamed tree: `go build ./...` and `go vet ./api/` both still pass — they see nothing wrong — while `go test ./api/` FAILS, because the runtime function name now carries the new path and goleak stops ignoring `ws.(*Hub).Run.func1`. Restoring the line makes it pass. `go.sum` is byte-identical (no `go mod tidy` was run and none was needed). All four build-tag variants compile; `go vet ./...`, `go vet -tags otel,wazero ./...` and `go vet -tags deadlock ./...` pass; `go test -race ./...` is 16/16 packages green; `go test -tags deadlock ./...` passes; the tag-gated `./plugin/...` (wazero) and `./telemetry/...` (otel) runs pass. `golangci-lint` v2.11.3 — the pinned CI version, rebuilt locally against Go 1.26 because the packaged binary cannot load a 1.26 config — reports **0 issues**. `go run ./cmd/genprotocol` leaves `git diff --exit-code ws/message_types.go ../Client/src/lib/protocolTypes.ts` clean, so the rename does not reach the generated protocol constants. `npx prettier --check .` and `node .superpowers/render-ledger.mjs --check` pass. Not included: `docs/audit-2026-08-23-repository-layout.md` and `docs/plans/b1-repository-foundation-2026-08-25.md` keep the old path — they are the audit row and the measurement that motivated this change, and rewriting them would erase the record of what was measured. They are why the residual check needs a two-path allowance rather than being empty; that allowance is stated above rather than hidden in a pathspec. `telemetry/metrics.go:19` declares `scopeVoice` for a `Server/voice` package that does not exist; the substitution carried the dead path forward verbatim as `github.com/J3vb/OwnCord/Server/voice` rather than fixing it, because correcting a real observability bug inside a mechanical rename would hide it in a 350-file diff. It needs its own item. No `go.work`, no second module, and no vanity-import host was set up — the new path resolves against the real repository, but nothing imports this module as a library, so `go get` reachability was not exercised either way. Refs RL-13, L-12
231 lines
7.7 KiB
Go
231 lines
7.7 KiB
Go
// Phase C Step 9 — Plugin admin REST surface.
|
|
//
|
|
// All endpoints are mounted under the existing AdminIPRestrict group so they
|
|
// inherit the same network ACL as the rest of the admin panel. Authentication
|
|
// is handled by the admin handler's middleware before this handler runs.
|
|
|
|
package api
|
|
|
|
import (
|
|
"io"
|
|
"log/slog"
|
|
"net/http"
|
|
"strconv"
|
|
"strings"
|
|
|
|
"github.com/J3vb/OwnCord/Server/plugin"
|
|
"github.com/go-chi/chi/v5"
|
|
)
|
|
|
|
// maxPluginUploadBytes caps the multipart upload at 16 MiB to match the
|
|
// plugin.maxZipBytes ceiling. The handler enforces both layers because the
|
|
// outer MaxBytesReader gives a clean 413 instead of a partial extract.
|
|
const maxPluginUploadBytes = 16 * 1024 * 1024
|
|
|
|
// PluginAdminHandler exposes plugin lifecycle operations to the admin panel.
|
|
type PluginAdminHandler struct {
|
|
registry *plugin.Registry
|
|
store plugin.PluginStore
|
|
}
|
|
|
|
// NewPluginAdminHandler builds an http.Handler that the router can mount.
|
|
// Pass a nil registry when plugin support is disabled — the handler then
|
|
// reports an empty list and 503 on lifecycle calls.
|
|
func NewPluginAdminHandler(registry *plugin.Registry, st plugin.PluginStore) http.Handler {
|
|
h := &PluginAdminHandler{registry: registry, store: st}
|
|
r := chi.NewRouter()
|
|
r.Get("/", h.list)
|
|
r.Post("/install", h.install)
|
|
r.Post("/{id}/enable", h.enable)
|
|
r.Post("/{id}/disable", h.disable)
|
|
r.Delete("/{id}", h.uninstall)
|
|
return r
|
|
}
|
|
|
|
// install accepts a multipart upload with a single "plugin" file part
|
|
// containing a .zip. The zip is validated (zip-slip safe, no symlinks,
|
|
// uncompressed total capped, manifest required at root) and installed via
|
|
// Registry.InstallFromZip. Returns 201 with the new plugin name on success.
|
|
func (h *PluginAdminHandler) install(w http.ResponseWriter, r *http.Request) {
|
|
if h.registry == nil {
|
|
http.Error(w, "plugin runtime disabled", http.StatusServiceUnavailable)
|
|
return
|
|
}
|
|
// Hard cap on the request body before parsing multipart so a hostile
|
|
// client can't tie up parsing memory.
|
|
r.Body = http.MaxBytesReader(w, r.Body, maxPluginUploadBytes+1024)
|
|
if err := r.ParseMultipartForm(maxPluginUploadBytes); err != nil {
|
|
http.Error(w, "invalid multipart upload", http.StatusBadRequest)
|
|
return
|
|
}
|
|
file, header, err := r.FormFile("plugin")
|
|
if err != nil {
|
|
http.Error(w, "missing 'plugin' file part", http.StatusBadRequest)
|
|
return
|
|
}
|
|
defer file.Close() //nolint:errcheck
|
|
|
|
// Reject obviously-wrong uploads early. The real defence is the zip
|
|
// reader inside InstallFromZip (content-type is client-supplied and must
|
|
// never be trusted for authorisation), but rejecting non-zip MIME types
|
|
// here returns a cleaner 400 than a "not a valid zip" error from deep
|
|
// inside the registry.
|
|
if header != nil {
|
|
if ct := header.Header.Get("Content-Type"); ct != "" && !isZipContentType(ct) {
|
|
http.Error(w, "plugin upload must be a .zip archive", http.StatusUnsupportedMediaType)
|
|
return
|
|
}
|
|
}
|
|
|
|
// Read the entire zip into memory — InstallFromZip needs an io.ReaderAt
|
|
// for archive/zip and the cap is small enough to be safe.
|
|
body, err := io.ReadAll(io.LimitReader(file, maxPluginUploadBytes+1))
|
|
if err != nil {
|
|
http.Error(w, "failed to read upload", http.StatusBadRequest)
|
|
return
|
|
}
|
|
if int64(len(body)) > maxPluginUploadBytes {
|
|
http.Error(w, "plugin upload too large", http.StatusRequestEntityTooLarge)
|
|
return
|
|
}
|
|
// Magic-byte check: a real .zip starts with "PK\x03\x04" (local file
|
|
// header) or "PK\x05\x06" (empty archive). Anything else is definitively
|
|
// not a zip regardless of what the client labelled it.
|
|
if !hasZipMagic(body) {
|
|
http.Error(w, "plugin upload is not a valid zip archive", http.StatusBadRequest)
|
|
return
|
|
}
|
|
name, err := h.registry.InstallFromZip(r.Context(), body)
|
|
if err != nil {
|
|
slog.Error("plugin install failed", "error", err)
|
|
writeJSON(w, http.StatusBadRequest, errorResponse{
|
|
Error: "INSTALL_FAILED",
|
|
Message: "plugin installation failed",
|
|
})
|
|
return
|
|
}
|
|
writeJSON(w, http.StatusCreated, map[string]any{"name": name})
|
|
}
|
|
|
|
func (h *PluginAdminHandler) list(w http.ResponseWriter, r *http.Request) {
|
|
ctx := r.Context()
|
|
// An empty list means "nothing installed" on a server with the runtime on,
|
|
// and "you can't install anything" on a server with it off. The caller
|
|
// can't tell those apart from the body, so say which it is — otherwise the
|
|
// admin panel's empty state has to guess.
|
|
w.Header().Set("X-Plugin-Runtime", pluginRuntimeState(h.registry))
|
|
if h.store == nil {
|
|
writeJSON(w, http.StatusOK, []any{})
|
|
return
|
|
}
|
|
rows, err := h.store.ListPlugins(ctx)
|
|
if err != nil {
|
|
slog.Error("plugin list failed", "error", err)
|
|
http.Error(w, "internal server error", http.StatusInternalServerError)
|
|
return
|
|
}
|
|
writeJSON(w, http.StatusOK, rows)
|
|
}
|
|
|
|
func (h *PluginAdminHandler) enable(w http.ResponseWriter, r *http.Request) {
|
|
id, ok := parsePluginID(w, r)
|
|
if !ok {
|
|
return
|
|
}
|
|
if h.registry == nil {
|
|
http.Error(w, "plugin runtime disabled", http.StatusServiceUnavailable)
|
|
return
|
|
}
|
|
if err := h.registry.EnablePlugin(r.Context(), id); err != nil {
|
|
slog.Error("plugin enable failed", "id", id, "error", err)
|
|
http.Error(w, "internal server error", http.StatusInternalServerError)
|
|
return
|
|
}
|
|
w.WriteHeader(http.StatusNoContent)
|
|
}
|
|
|
|
func (h *PluginAdminHandler) disable(w http.ResponseWriter, r *http.Request) {
|
|
id, ok := parsePluginID(w, r)
|
|
if !ok {
|
|
return
|
|
}
|
|
if h.registry == nil {
|
|
http.Error(w, "plugin runtime disabled", http.StatusServiceUnavailable)
|
|
return
|
|
}
|
|
if err := h.registry.DisablePlugin(r.Context(), id); err != nil {
|
|
slog.Error("plugin disable failed", "id", id, "error", err)
|
|
http.Error(w, "internal server error", http.StatusInternalServerError)
|
|
return
|
|
}
|
|
w.WriteHeader(http.StatusNoContent)
|
|
}
|
|
|
|
func (h *PluginAdminHandler) uninstall(w http.ResponseWriter, r *http.Request) {
|
|
id, ok := parsePluginID(w, r)
|
|
if !ok {
|
|
return
|
|
}
|
|
if h.registry == nil {
|
|
http.Error(w, "plugin runtime disabled", http.StatusServiceUnavailable)
|
|
return
|
|
}
|
|
if err := h.registry.UninstallPlugin(r.Context(), id); err != nil {
|
|
slog.Error("plugin uninstall failed", "id", id, "error", err)
|
|
http.Error(w, "internal server error", http.StatusInternalServerError)
|
|
return
|
|
}
|
|
w.WriteHeader(http.StatusNoContent)
|
|
}
|
|
|
|
// pluginRuntimeState reports whether lifecycle calls will work, for the
|
|
// X-Plugin-Runtime response header. A nil registry means plugin support is
|
|
// compiled/configured off and every lifecycle endpoint answers 503.
|
|
func pluginRuntimeState(registry *plugin.Registry) string {
|
|
if registry == nil {
|
|
return "disabled"
|
|
}
|
|
return "enabled"
|
|
}
|
|
|
|
// isZipContentType reports whether ct looks like a zip MIME type. Both the
|
|
// IANA-registered application/zip and the legacy application/x-zip-compressed
|
|
// (used by some Windows clients) are accepted. The comparison is case-
|
|
// insensitive and strips any parameters after a semicolon.
|
|
func isZipContentType(ct string) bool {
|
|
for i := 0; i < len(ct); i++ {
|
|
if ct[i] == ';' {
|
|
ct = ct[:i]
|
|
break
|
|
}
|
|
}
|
|
switch strings.ToLower(strings.TrimSpace(ct)) {
|
|
case "application/zip", "application/x-zip-compressed", "application/octet-stream":
|
|
return true
|
|
}
|
|
return false
|
|
}
|
|
|
|
// hasZipMagic reports whether b begins with the PK signature used by every
|
|
// .zip archive. Empty archives use 0x50,0x4b,0x05,0x06; non-empty archives
|
|
// start with a local file header 0x50,0x4b,0x03,0x04. Both are accepted.
|
|
func hasZipMagic(b []byte) bool {
|
|
if len(b) < 4 {
|
|
return false
|
|
}
|
|
if b[0] != 'P' || b[1] != 'K' {
|
|
return false
|
|
}
|
|
return (b[2] == 0x03 && b[3] == 0x04) || (b[2] == 0x05 && b[3] == 0x06)
|
|
}
|
|
|
|
func parsePluginID(w http.ResponseWriter, r *http.Request) (int64, bool) {
|
|
idStr := chi.URLParam(r, "id")
|
|
id, err := strconv.ParseInt(idStr, 10, 64)
|
|
if err != nil || id <= 0 {
|
|
http.Error(w, "invalid plugin id", http.StatusBadRequest)
|
|
return 0, false
|
|
}
|
|
return id, true
|
|
}
|