refactor(api-keys): simplify authorization to a single-role gate
Redesign tenant API key authorization around one dimension (role) plus a central default-deny gate, replacing the previous role + KB-scoped flag model. - Add APIKeyGate as the single authority for API-key authorization: routes declare one policy (MinRole) via apiKeyGroup/apiKeyRoute helpers; undeclared routes are denied by default. JWT principals short-circuit the gate and the JWT-centric RBAC guards short-circuit for API-key principals. - Roles: viewer/contributor/admin are knowledge-base data-plane only (KB scope is a pure downstream data filter); owner is a full-access tenant tier that unlocks tenant-level infrastructure routes and is required for every method. - Drop the KBScoped policy flag and the KB-restricted-vs-tenant branching. - Security hardening: never disclose HMAC secret (return presence only), abort writes on API-key encryption failure, deny KB-restricted keys on /files, and backfill legacy key hashes at startup instead of O(N) plaintext scans. - Frontend: two-level create dialog (access type -> permission level), rename role labels to reflect actual scope, sync en/zh/ko/ru locales. - Fix startup self-check false-positive on trailing-slash routes and normalize gin paths before comparison; add regression tests.
This commit is contained in:
@@ -0,0 +1,166 @@
|
||||
package middleware
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"testing"
|
||||
|
||||
"github.com/Tencent/WeKnora/internal/types"
|
||||
"github.com/gin-gonic/gin"
|
||||
)
|
||||
|
||||
func newTestAuthorizer() *APIKeyRouteAuthorizer {
|
||||
a := NewAPIKeyRouteAuthorizer()
|
||||
// Data-plane routes (Viewer read, Contributor write, Admin destructive)
|
||||
// plus one tenant-level Owner route.
|
||||
a.Register(http.MethodGet, "/api/v1/knowledge-bases/:id", policyMinRole(types.TenantRoleViewer))
|
||||
a.Register(http.MethodPost, "/api/v1/knowledge-bases/:id/knowledge/file", policyMinRole(types.TenantRoleContributor))
|
||||
a.Register(http.MethodDelete, "/api/v1/knowledge-bases/:id/knowledge", policyMinRole(types.TenantRoleAdmin))
|
||||
a.Register(http.MethodGet, "/api/v1/models", policyMinRole(types.TenantRoleOwner))
|
||||
a.Register(http.MethodPut, "/api/v1/tenants/kv/:key", policyMinRole(types.TenantRoleOwner))
|
||||
return a
|
||||
}
|
||||
|
||||
func policyMinRole(r types.TenantRole) APIKeyRoutePolicy {
|
||||
return APIKeyRoutePolicy{MinRole: r}
|
||||
}
|
||||
|
||||
// runGate exercises the gate middleware with a given scope, method and route
|
||||
// full-path, returning whether the request was allowed to proceed.
|
||||
func runGate(t *testing.T, a *APIKeyRouteAuthorizer, scope *types.TenantAPIKeyScope, method, fullPath string) bool {
|
||||
t.Helper()
|
||||
gin.SetMode(gin.TestMode)
|
||||
engine := gin.New()
|
||||
engine.Use(func(c *gin.Context) {
|
||||
if scope != nil {
|
||||
c.Request = c.Request.WithContext(types.WithTenantAPIKeyScope(c.Request.Context(), *scope))
|
||||
}
|
||||
c.Next()
|
||||
})
|
||||
engine.Use(a.Middleware())
|
||||
allowed := false
|
||||
engine.Handle(method, fullPath, func(c *gin.Context) {
|
||||
allowed = true
|
||||
c.Status(http.StatusOK)
|
||||
})
|
||||
|
||||
w := httptest.NewRecorder()
|
||||
engine.ServeHTTP(w, httptest.NewRequest(method, concretePath(fullPath), nil))
|
||||
return allowed && w.Code == http.StatusOK
|
||||
}
|
||||
|
||||
// concretePath substitutes gin :params with literals so httptest can hit it.
|
||||
func concretePath(tmpl string) string {
|
||||
switch tmpl {
|
||||
case "/api/v1/knowledge-bases/:id":
|
||||
return "/api/v1/knowledge-bases/kb-1"
|
||||
case "/api/v1/knowledge-bases/:id/knowledge/file":
|
||||
return "/api/v1/knowledge-bases/kb-1/knowledge/file"
|
||||
case "/api/v1/knowledge-bases/:id/knowledge":
|
||||
return "/api/v1/knowledge-bases/kb-1/knowledge"
|
||||
case "/api/v1/tenants/kv/:key":
|
||||
return "/api/v1/tenants/kv/some-key"
|
||||
default:
|
||||
return tmpl
|
||||
}
|
||||
}
|
||||
|
||||
func TestGateJWTPassesThrough(t *testing.T) {
|
||||
a := newTestAuthorizer()
|
||||
// No scope => JWT principal => always allowed, even on an Owner route.
|
||||
if !runGate(t, a, nil, http.MethodGet, "/api/v1/models") {
|
||||
t.Fatal("JWT principal must pass the gate")
|
||||
}
|
||||
}
|
||||
|
||||
func TestGateDefaultDeny(t *testing.T) {
|
||||
a := newTestAuthorizer()
|
||||
owner := &types.TenantAPIKeyScope{Role: types.TenantRoleOwner}
|
||||
gin.SetMode(gin.TestMode)
|
||||
engine := gin.New()
|
||||
engine.Use(func(c *gin.Context) {
|
||||
c.Request = c.Request.WithContext(types.WithTenantAPIKeyScope(c.Request.Context(), *owner))
|
||||
c.Next()
|
||||
})
|
||||
engine.Use(a.Middleware())
|
||||
engine.POST("/api/v1/agents", func(c *gin.Context) { c.Status(http.StatusOK) })
|
||||
w := httptest.NewRecorder()
|
||||
engine.ServeHTTP(w, httptest.NewRequest(http.MethodPost, "/api/v1/agents", nil))
|
||||
if w.Code != http.StatusForbidden {
|
||||
t.Fatalf("undeclared route should default-deny even an Owner key: status=%d", w.Code)
|
||||
}
|
||||
}
|
||||
|
||||
func TestGateDataPlaneRoleLadder(t *testing.T) {
|
||||
a := newTestAuthorizer()
|
||||
viewer := &types.TenantAPIKeyScope{Role: types.TenantRoleViewer}
|
||||
contributor := &types.TenantAPIKeyScope{Role: types.TenantRoleContributor}
|
||||
admin := &types.TenantAPIKeyScope{Role: types.TenantRoleAdmin}
|
||||
|
||||
// Safe read: any data-plane key (Viewer) passes.
|
||||
if !runGate(t, a, viewer, http.MethodGet, "/api/v1/knowledge-bases/:id") {
|
||||
t.Fatal("viewer key should read a declared KB route")
|
||||
}
|
||||
// Contributor write.
|
||||
if runGate(t, a, viewer, http.MethodPost, "/api/v1/knowledge-bases/:id/knowledge/file") {
|
||||
t.Fatal("viewer key must not perform a contributor write")
|
||||
}
|
||||
if !runGate(t, a, contributor, http.MethodPost, "/api/v1/knowledge-bases/:id/knowledge/file") {
|
||||
t.Fatal("contributor key should perform a contributor write")
|
||||
}
|
||||
// Admin destructive.
|
||||
if runGate(t, a, contributor, http.MethodDelete, "/api/v1/knowledge-bases/:id/knowledge") {
|
||||
t.Fatal("contributor key must not perform an admin destructive op")
|
||||
}
|
||||
if !runGate(t, a, admin, http.MethodDelete, "/api/v1/knowledge-bases/:id/knowledge") {
|
||||
t.Fatal("admin key should perform an admin destructive op")
|
||||
}
|
||||
}
|
||||
|
||||
func TestGateTenantRoutesRequireOwner(t *testing.T) {
|
||||
a := newTestAuthorizer()
|
||||
admin := &types.TenantAPIKeyScope{Role: types.TenantRoleAdmin}
|
||||
owner := &types.TenantAPIKeyScope{Role: types.TenantRoleOwner}
|
||||
|
||||
// Even a safe GET on a tenant-level route requires Owner (no Viewer floor).
|
||||
if runGate(t, a, admin, http.MethodGet, "/api/v1/models") {
|
||||
t.Fatal("admin key must NOT read a tenant-level route")
|
||||
}
|
||||
if !runGate(t, a, owner, http.MethodGet, "/api/v1/models") {
|
||||
t.Fatal("owner key should read a tenant-level route")
|
||||
}
|
||||
// Unsafe tenant write also requires Owner.
|
||||
if runGate(t, a, admin, http.MethodPut, "/api/v1/tenants/kv/:key") {
|
||||
t.Fatal("admin key must NOT write a tenant-level route")
|
||||
}
|
||||
if !runGate(t, a, owner, http.MethodPut, "/api/v1/tenants/kv/:key") {
|
||||
t.Fatal("owner key should write a tenant-level route")
|
||||
}
|
||||
}
|
||||
|
||||
func TestGateKBScopeDoesNotBlockDataPlane(t *testing.T) {
|
||||
a := newTestAuthorizer()
|
||||
// A KB-restricted key is NOT blocked by the gate on data-plane routes;
|
||||
// its KB allow-list is enforced downstream by KBAccess/handler checks.
|
||||
restricted := &types.TenantAPIKeyScope{
|
||||
Role: types.TenantRoleContributor,
|
||||
KnowledgeBaseIDs: types.StringArray{"kb-1"},
|
||||
}
|
||||
if !runGate(t, a, restricted, http.MethodPost, "/api/v1/knowledge-bases/:id/knowledge/file") {
|
||||
t.Fatal("KB-restricted contributor key should pass the gate on a data-plane write")
|
||||
}
|
||||
}
|
||||
|
||||
func TestNormalizeRoutePath(t *testing.T) {
|
||||
cases := map[string]string{
|
||||
"/api/v1//models": "/api/v1/models",
|
||||
"/api/v1/models/": "/api/v1/models",
|
||||
"/": "/",
|
||||
"/api/v1/agents": "/api/v1/agents",
|
||||
}
|
||||
for in, want := range cases {
|
||||
if got := normalizeRoutePath(in); got != want {
|
||||
t.Fatalf("normalizeRoutePath(%q)=%q want %q", in, got, want)
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user