Files
pages/internal/server/endpoint_policy.go
T
Anya Tokugawa d5d21b7841
Build and publish container images / images (push) Successful in 9m34s
Release container images / release (push) Successful in 36s
Refactor architecture into eight components and consolidate reliability work
Extract Grammaratur, Dregarnuhr, Geduldh, Mestionora, Ordoschnellic, Schutzaria, Kunstzeal and Seheweit behind compatible application contracts.

Include accumulated editor resilience, navigation and theme UX, remote CLI, storage/schema and DR groundwork, tests and design/operations documentation.

Verified: uncached full Go suite; go vet ./...; race tests for all eight components; 11 targeted Chromium tests; Node suites; 19 Python CLI tests; reproducible editor build. No push, release tag or deployment in this checkpoint.
2026-11-01 15:23:31 +09:00

222 lines
13 KiB
Go

package server
import (
"net/http"
"strings"
)
type authorizationTargetKind string
const (
targetPath authorizationTargetKind = "path"
targetDomain authorizationTargetKind = "domain"
)
type endpointPolicy struct {
Name string
Capability string
Target authorizationTargetKind
Resolver endpointTargetResolver
}
type endpointTargetResolver string
const (
resolveNone endpointTargetResolver = ""
resolveHandler endpointTargetResolver = "handler"
resolveObjectURL endpointTargetResolver = "object_url"
resolveRevision endpointTargetResolver = "revision_url"
resolveRaw endpointTargetResolver = "raw_address"
resolveText endpointTargetResolver = "text_revision"
resolvePDF endpointTargetResolver = "pdf_revision"
resolvePreview endpointTargetResolver = "preview_document"
resolveQueryPath endpointTargetResolver = "query_path"
resolveViewPath endpointTargetResolver = "view_path"
resolvePrint endpointTargetResolver = "print_address"
resolveDiff endpointTargetResolver = "revision_diff"
)
var endpointPolicies = map[string]endpointPolicy{
"GET /_/api/v1/editor/state": {Name: "editor.state", Capability: "read", Target: targetDomain, Resolver: resolveHandler},
"POST /_/api/v1/editor/convert": {Name: "editor.convert", Capability: "read", Target: targetDomain, Resolver: resolveHandler},
"GET /_/api/v1/extension": {Name: "extension.catalog", Capability: "manage", Target: targetDomain, Resolver: resolveHandler},
"POST /-/sys/config/vim": {Name: "config.vim", Capability: "manage", Target: targetDomain, Resolver: resolveHandler},
"GET /:/new": {Name: "page.create_form", Capability: "create", Target: targetDomain},
"GET /v/upload": {Name: "upload.form", Capability: "read", Target: targetDomain},
"GET /_/api/v1/object/list": {Name: "object.list", Capability: "read", Target: targetDomain, Resolver: resolveHandler},
"GET /_/api/v1/path-picker": {Name: "path_picker.list", Capability: "read", Target: targetDomain, Resolver: resolveHandler},
"GET /_/api/v1/search/suggest": {Name: "search.suggest", Capability: "read", Target: targetDomain, Resolver: resolveHandler},
"GET /_/api/v1/browser/navigation": {Name: "browser.navigation.list", Capability: "read", Target: targetDomain, Resolver: resolveHandler},
"HEAD /_/api/v1/object/list": {Name: "object.list", Capability: "read", Target: targetDomain, Resolver: resolveHandler},
"GET /_/api/v1/revisions/list": {Name: "revision.list", Capability: "read", Target: targetDomain, Resolver: resolveHandler},
"HEAD /_/api/v1/revisions/list": {Name: "revision.list", Capability: "read", Target: targetDomain, Resolver: resolveHandler},
"GET /_/api/v1/gc/zombies/list": {Name: "gc.list", Capability: "manage", Target: targetDomain},
"POST /:/new": {Name: "page.create", Capability: "create", Target: targetDomain},
"POST /:/compile/markdown": {Name: "render.markdown", Capability: "read", Target: targetDomain},
"POST /_/api/v1/object/create": {Name: "object.create", Capability: "create", Target: targetDomain},
"POST /_/api/v1/object/delete": {Name: "object.delete", Capability: "delete", Target: targetDomain, Resolver: resolveHandler},
"POST /_/api/v1/revisions/save": {Name: "revision.save", Capability: "write", Target: targetDomain, Resolver: resolveHandler},
"POST /_/api/v1/revisions/restore": {Name: "revision.restore", Capability: "write", Target: targetDomain, Resolver: resolveHandler},
"POST /_/api/v1/render/markdown": {Name: "render.markdown", Capability: "read", Target: targetDomain, Resolver: resolveHandler},
"POST /_/api/v1/tag/add": {Name: "tag.add", Capability: "write", Target: targetDomain},
"POST /_/api/v1/path/bind": {Name: "path.bind", Capability: "link", Target: targetDomain, Resolver: resolveHandler},
"POST /_/api/v1/path/rename": {Name: "path.rename", Capability: "rename", Target: targetDomain, Resolver: resolveHandler},
"POST /_/api/v1/path/rename-preview": {Name: "path.rename_preview", Capability: "rename", Target: targetDomain, Resolver: resolveHandler},
"POST /_/api/v1/path/remove": {Name: "path.remove", Capability: "delete", Target: targetDomain, Resolver: resolveHandler},
"POST /_/api/v1/path/copy": {Name: "path.copy", Capability: "create", Target: targetDomain, Resolver: resolveHandler},
"POST /_/api/v1/browser/navigation": {Name: "browser.navigation.add", Capability: "read", Target: targetDomain, Resolver: resolveHandler},
"PATCH /_/api/v1/browser/navigation": {Name: "browser.navigation.rename", Capability: "read", Target: targetDomain, Resolver: resolveHandler},
"DELETE /_/api/v1/browser/navigation": {Name: "browser.navigation.delete", Capability: "read", Target: targetDomain, Resolver: resolveHandler},
"POST /_/api/v1/gc/zombies/purge": {Name: "gc.purge", Capability: "delete", Target: targetDomain},
"POST /v/upload": {Name: "document.upload", Capability: "upload", Target: targetDomain, Resolver: resolveHandler},
"GET /_/api/v1/assets": {Name: "asset.list", Capability: "manage", Target: targetDomain, Resolver: resolveHandler},
"POST /_/api/v1/assets": {Name: "asset.create", Capability: "manage", Target: targetDomain, Resolver: resolveHandler},
"DELETE /_/api/v1/assets": {Name: "asset.delete", Capability: "manage", Target: targetDomain, Resolver: resolveHandler},
"GET /_/api/v1/notifications": {Name: "notifications.list", Capability: "read", Target: targetDomain, Resolver: resolveHandler},
"GET /_/api/v1/notifications/push": {Name: "notifications.push", Capability: "read", Target: targetDomain, Resolver: resolveHandler},
"POST /_/api/v1/notifications/push": {Name: "notifications.push", Capability: "read", Target: targetDomain, Resolver: resolveHandler},
"DELETE /_/api/v1/notifications/push": {Name: "notifications.push", Capability: "read", Target: targetDomain, Resolver: resolveHandler},
"POST /_/api/v1/notifications/read": {Name: "notifications.read", Capability: "read", Target: targetDomain, Resolver: resolveHandler},
"PATCH /_/api/v1/notifications/read": {Name: "notifications.read", Capability: "read", Target: targetDomain, Resolver: resolveHandler},
"POST /_/api/v1/publication/requests": {Name: "publication.request", Capability: "manage", Target: targetDomain, Resolver: resolveHandler},
"POST /_/api/v1/publication/requests/": {Name: "publication.decide", Capability: "manage", Target: targetDomain, Resolver: resolveHandler},
}
var mutationPrefixPolicies = []struct {
Prefix string
Policy endpointPolicy
}{
{Prefix: "/e/", Policy: endpointPolicy{Name: "document.edit", Capability: "write", Target: targetPath}},
{Prefix: "/-/sys/", Policy: endpointPolicy{Name: "system.manage", Capability: "manage", Target: targetDomain}},
{Prefix: "/_/api/v1/event", Policy: endpointPolicy{Name: "event.manage", Capability: "manage", Target: targetDomain}},
{Prefix: "/_/api/v1/queue", Policy: endpointPolicy{Name: "queue.manage", Capability: "manage", Target: targetDomain}},
{Prefix: "/_/api/v1/adapter", Policy: endpointPolicy{Name: "adapter.manage", Capability: "manage", Target: targetDomain}},
{Prefix: "/_/api/v1/publication/requests/", Policy: endpointPolicy{Name: "publication.decide", Capability: "manage", Target: targetDomain, Resolver: resolveHandler}},
{Prefix: "/_/api/v1/city/", Policy: endpointPolicy{Name: "city.mutate", Capability: "write", Target: targetDomain}},
{Prefix: "/_/api/v1/import/", Policy: endpointPolicy{Name: "import.mutate", Capability: "write", Target: targetDomain}},
{Prefix: "/v/import", Policy: endpointPolicy{Name: "import.mutate", Capability: "write", Target: targetDomain}},
{Prefix: "/:/compile/diagram/", Policy: endpointPolicy{Name: "render.diagram", Capability: "read", Target: targetDomain}},
{Prefix: "/l/", Policy: endpointPolicy{Name: "path.link", Capability: "link", Target: targetDomain, Resolver: resolveHandler}},
}
func policyForRequest(r *http.Request) endpointPolicy {
if taskRoute(r.URL.Path) {
return endpointPolicy{Name: "tasks.handler", Capability: "read", Target: targetDomain, Resolver: resolveHandler}
}
if calendarRoute(r.URL.Path) {
return endpointPolicy{Name: "calendar.handler", Capability: "read", Target: targetDomain, Resolver: resolveHandler}
}
if kind, operation := periodicalRoute(r.URL.Path); kind != "" {
if (r.Method == "GET" && operation != "posts") || (r.Method == "POST" && operation != "view" && operation != "plan" && operation != "new") {
capability := "read"
if r.Method == "POST" {
capability = "write"
if operation == "settings" {
capability = "manage"
}
}
return endpointPolicy{Name: "extension." + kind + "." + operation, Capability: capability, Target: targetDomain, Resolver: resolveHandler}
}
return endpointPolicy{Name: "extension.method.undefined", Capability: "deny", Target: targetDomain}
}
if cityGovernanceRoute(r.URL.Path) {
return endpointPolicy{Name: "city.governance", Capability: "manage", Target: targetDomain, Resolver: resolveHandler}
}
cleanPath := strings.TrimSuffix(r.URL.Path, "/")
if policy, ok := endpointPolicies[r.Method+" "+cleanPath]; ok {
return policy
}
// Exact routes are method-closed. This also protects older handlers that do
// not yet carry their own explicit method guard.
for route := range endpointPolicies {
_, declaredPath, ok := strings.Cut(route, " ")
if ok && declaredPath == cleanPath {
return endpointPolicy{Name: "method.undefined", Capability: "deny", Target: targetDomain}
}
}
if r.Method == http.MethodGet || r.Method == http.MethodHead || r.Method == http.MethodOptions {
if resolver, capability := readEndpointResolver(r.URL.Path); resolver != resolveNone {
return endpointPolicy{Name: "derived.read", Capability: capability, Target: targetPath, Resolver: resolver}
}
if strings.HasPrefix(r.URL.Path, "/e/") {
return endpointPolicy{Name: "document.editor", Capability: "write", Target: targetPath}
}
if strings.HasPrefix(r.URL.Path, "/-/sys/") ||
strings.HasPrefix(r.URL.Path, "/_/api/v1/event") ||
strings.HasPrefix(r.URL.Path, "/_/api/v1/queue") {
return endpointPolicy{Name: "system.read", Capability: "manage", Target: targetDomain}
}
return endpointPolicy{Name: "content.read", Capability: "read", Target: endpointTargetKind(r.URL.Path)}
}
for _, rule := range mutationPrefixPolicies {
if strings.HasPrefix(r.URL.Path, rule.Prefix) {
return rule.Policy
}
}
if isReservedEndpoint(r.URL.Path) {
return endpointPolicy{Name: "reserved.undefined", Capability: "deny", Target: targetDomain}
}
return endpointPolicy{Name: "document.mutate", Capability: "write", Target: targetPath}
}
func readEndpointResolver(path string) (endpointTargetResolver, string) {
switch {
case path == "/v/browser", strings.HasPrefix(path, "/v/browser/"):
return resolveHandler, "read"
case path == "/v/children", path == "/v/tree", strings.HasPrefix(path, "/v/tree/"):
return resolveHandler, "read"
case path == "/v/city", strings.HasPrefix(path, "/v/city/"), strings.HasPrefix(path, "/_/api/v1/city/"):
return resolveHandler, "read"
case path == "/v/bookmarks":
return resolveHandler, "read"
case strings.HasPrefix(path, "/_/obj/"):
return resolveHandler, "read"
case strings.HasPrefix(path, "/v/raw/"):
return resolveRaw, "read"
case strings.HasPrefix(path, "/v/text/"):
return resolveText, "read"
case path == "/v/pdf-page":
return resolvePDF, "read"
case strings.HasPrefix(path, "/v/preview-cache/"):
return resolvePreview, "read"
case path == "/v/archive", path == "/v/email-html":
return resolveQueryPath, "read"
case path == "/v/search", path == "/v/tree", strings.HasPrefix(path, "/v/tree/"):
return resolveHandler, "read"
case strings.HasPrefix(path, "/_/view/print/"):
return resolvePrint, "read"
case strings.HasPrefix(path, "/v/preview"), strings.HasPrefix(path, "/v/plain"), strings.HasPrefix(path, "/v/markdown"):
return resolveViewPath, "read"
case strings.HasPrefix(path, "/o/e/"):
return resolveObjectURL, "write"
case strings.HasPrefix(path, "/l/uuid:"):
return resolveObjectURL, "read"
case strings.HasPrefix(path, "/o/r/"), strings.HasPrefix(path, "/o/"):
return resolveObjectURL, "read"
case strings.HasPrefix(path, "/r/history/"):
return resolveObjectURL, "read"
case strings.HasPrefix(path, "/r/view/"):
return resolveRevision, "read"
case strings.HasPrefix(path, "/r/diff/"):
return resolveDiff, "read"
}
return resolveNone, ""
}
func endpointTargetKind(path string) authorizationTargetKind {
if isReservedEndpoint(path) {
return targetDomain
}
return targetPath
}
func isReservedEndpoint(path string) bool {
for _, prefix := range []string{"/_/", "/-/", "/:/", "/o/", "/r/", "/v/", "/l/", "/static/"} {
if strings.HasPrefix(path, prefix) {
return true
}
}
return false
}