mirror of
https://github.com/shishantbiswas/bknd.git
synced 2026-03-17 21:06:04 +00:00
refactor: restructure permission handling and enhance Guard functionality
- Introduced a new `createGuard` function to streamline the creation of Guard instances with permissions and roles. - Updated tests in `authorize.spec.ts` to reflect changes in permission checks, ensuring they now return undefined for denied permissions. - Added new `Permission` and `Policy` classes to improve type safety and flexibility in permission management. - Refactored middleware and controller files to utilize the updated permission structure, including context handling for permissions. - Created a new `SystemController.spec.ts` file to test the integration of the new permission system within the SystemController. - Removed legacy permission handling from core security files, consolidating permission logic within the new structure.
This commit is contained in:
93
app/src/auth/middlewares/permission.middleware.ts
Normal file
93
app/src/auth/middlewares/permission.middleware.ts
Normal file
@@ -0,0 +1,93 @@
|
||||
import type { Permission, PermissionContext } from "auth/authorize/Permission";
|
||||
import { $console, threw } from "bknd/utils";
|
||||
import type { Context, Hono } from "hono";
|
||||
import type { RouterRoute } from "hono/types";
|
||||
import { createMiddleware } from "hono/factory";
|
||||
import type { ServerEnv } from "modules/Controller";
|
||||
import type { MaybePromise } from "core/types";
|
||||
|
||||
function getPath(reqOrCtx: Request | Context) {
|
||||
const req = reqOrCtx instanceof Request ? reqOrCtx : reqOrCtx.req.raw;
|
||||
return new URL(req.url).pathname;
|
||||
}
|
||||
|
||||
const permissionSymbol = Symbol.for("permission");
|
||||
|
||||
type PermissionMiddlewareOptions<P extends Permission<any, any, any, any>> = {
|
||||
onGranted?: (c: Context<ServerEnv>) => MaybePromise<Response | void | undefined>;
|
||||
onDenied?: (c: Context<ServerEnv>) => MaybePromise<Response | void | undefined>;
|
||||
} & (P extends Permission<any, any, infer PC, any>
|
||||
? PC extends undefined
|
||||
? {
|
||||
context?: never;
|
||||
}
|
||||
: {
|
||||
context: (c: Context<ServerEnv>) => MaybePromise<PermissionContext<P>>;
|
||||
}
|
||||
: {
|
||||
context?: never;
|
||||
});
|
||||
|
||||
export function permission<P extends Permission<any, any, any, any>>(
|
||||
permission: P,
|
||||
options: PermissionMiddlewareOptions<P>,
|
||||
) {
|
||||
// @ts-ignore (middlewares do not always return)
|
||||
const handler = createMiddleware<ServerEnv>(async (c, next) => {
|
||||
const app = c.get("app");
|
||||
const authCtx = c.get("auth");
|
||||
if (!authCtx) {
|
||||
throw new Error("auth ctx not found");
|
||||
}
|
||||
|
||||
// in tests, app is not defined
|
||||
if (!authCtx.registered || !app) {
|
||||
const msg = `auth middleware not registered, cannot check permissions for ${getPath(c)}`;
|
||||
if (app?.module.auth.enabled) {
|
||||
throw new Error(msg);
|
||||
} else {
|
||||
$console.warn(msg);
|
||||
}
|
||||
} else if (!authCtx.skip) {
|
||||
const guard = app.modules.ctx().guard;
|
||||
const context = (await options?.context?.(c)) ?? ({} as any);
|
||||
|
||||
if (options?.onGranted || options?.onDenied) {
|
||||
let returned: undefined | void | Response;
|
||||
if (threw(() => guard.granted(permission, c, context))) {
|
||||
returned = await options?.onDenied?.(c);
|
||||
} else {
|
||||
returned = await options?.onGranted?.(c);
|
||||
}
|
||||
if (returned instanceof Response) {
|
||||
return returned;
|
||||
}
|
||||
} else {
|
||||
guard.granted(permission, c, context);
|
||||
}
|
||||
}
|
||||
|
||||
await next();
|
||||
});
|
||||
|
||||
return Object.assign(handler, {
|
||||
[permissionSymbol]: { permission, options },
|
||||
});
|
||||
}
|
||||
|
||||
export function getPermissionRoutes(hono: Hono<any>) {
|
||||
const routes: {
|
||||
route: RouterRoute;
|
||||
permission: Permission;
|
||||
options: PermissionMiddlewareOptions<Permission>;
|
||||
}[] = [];
|
||||
for (const route of hono.routes) {
|
||||
if (permissionSymbol in route.handler) {
|
||||
routes.push({
|
||||
route,
|
||||
...(route.handler[permissionSymbol] as any),
|
||||
});
|
||||
}
|
||||
}
|
||||
return routes;
|
||||
}
|
||||
Reference in New Issue
Block a user