@lanaqi/rsr 0.0.1-rc.0

package/README.md

@@ -0,0 +1,49 @@
+# React Security Router
+
+React 安全路由器
+
+# 框架说明
+
+rsr 是 react security router 的简写，一个基于 react router 实现路由级别控制的安全框架。
+
+功能简介：
+
+- 认证与授权
+- 权限检测
+- 二次签证（签名：如要求再次输入密码等）
+- 等等
+
+# 版本兼容
+
+注意：不兼容 react router 7 版本，在 v7 😒 版本上的 `useBlocker` 逻辑变更了，暂时不考虑兼容。
+
+# 简单例子
+
+``` tsx
+
+export default withSecurityBlocker(Root, bundler => {
+    return bundler
+        .context(builder => {
+            return builder
+                // 可选层级权限
+                // .hierarchy('superadmin>admin;admin>users;users>guest')
+                .resource(rb => rb.patterns('/login', '/logout', '/denied', '/signature').anonymous().build())
+                .resource(rb => rb.patterns('/sheet').permissions('admin').signatured().build())
+                .resource(rb => rb.patterns('/*').authenticated().build())
+                .build();
+        })
+        .manager(builder => {
+            return builder
+                .behave({
+                    notAuthenticationPath: '/login',
+                    notSignaturePath: '/signature',
+                    accessDeniedPath: '/denied',
+                })
+                .build();
+        })
+        // .addons()
+        .build()
+
+});
+
+```

package/dist/access/aaa.d.ts

@@ -0,0 +1,177 @@
+import type { AccessPermission, AccessPermissions } from './common';
+/**
+ * 访问认证
+ */
+export interface AccessAuthentication {
+    /**
+     * 是否已认证
+     */
+    isAuthenticated(): boolean;
+    /**
+     * 设置已认证
+     * @param authenticated 已认证
+     */
+    setAuthenticated(authenticated: boolean): void;
+}
+/**
+ * 访问授权
+ */
+export interface AccessAuthorization {
+    /**
+     * 获取权限集合
+     */
+    getPermissions(): Set<AccessPermission>;
+}
+/**
+ * 访问数据表
+ */
+export interface AccessDatasheet<Datasheet> {
+    /**
+     * 获取数据表
+     */
+    getDatasheet(): Datasheet;
+}
+/**
+ * 认证数据表
+ */
+export type AuthenticationDatasheet<P = unknown> = P & {
+    /**
+     * 已认证
+     */
+    readonly authenticated: boolean;
+};
+/**
+ * 授权数据表
+ */
+export type AuthorizationDatasheet<P = unknown> = P & {
+    /**
+     * 权限集合
+     */
+    readonly permissions: AccessPermissions | Set<AccessPermission>;
+};
+/**
+ * 用户数据表
+ */
+export type UserDatasheet<P = unknown> = P & AuthenticationDatasheet<P> & AuthorizationDatasheet<P> & {
+    /**
+     * 无效的
+     */
+    readonly invalid?: boolean;
+};
+/**
+ * 简单认证
+ */
+export declare class SimpleAuthentication<Datasheet> implements AccessAuthentication, AccessDatasheet<AuthenticationDatasheet<Datasheet>> {
+    /**
+     * 数据表
+     * @private
+     */
+    private readonly datasheet;
+    /**
+     * 已认证
+     * @private
+     */
+    private authenticated;
+    /**
+     * 构造函数
+     * @param datasheet 数据表
+     */
+    constructor(datasheet: AuthenticationDatasheet<Datasheet>);
+    /**
+     * 是否已认证
+     */
+    isAuthenticated(): boolean;
+    /**
+     * 设置已认证
+     * @param authenticated 已认证
+     */
+    setAuthenticated(authenticated: boolean): void;
+    /**
+     * 获取数据表
+     */
+    getDatasheet(): AuthenticationDatasheet<Datasheet>;
+}
+/**
+ * 简单授权
+ */
+export declare class SimpleAuthorization<Datasheet> implements AccessAuthorization, AccessDatasheet<AuthorizationDatasheet<Datasheet>> {
+    /**
+     * 数据表
+     * @private
+     */
+    private readonly datasheet;
+    /**
+     * 权限集合
+     * @private
+     */
+    private readonly permissions;
+    /**
+     * 构造函数
+     * @param datasheet 数据表
+     */
+    constructor(datasheet: AuthorizationDatasheet<Datasheet>);
+    /**
+     * 获取权限集合
+     */
+    getPermissions(): Set<AccessPermission>;
+    /**
+     * 获取数据表
+     */
+    getDatasheet(): AuthorizationDatasheet<Datasheet>;
+}
+/**
+ * 简单用户
+ */
+export declare class SimpleUser<Datasheet> implements AccessAuthentication, AccessAuthorization, AccessDatasheet<UserDatasheet<Datasheet>> {
+    /**
+     * 数据表
+     * @private
+     */
+    private readonly datasheet;
+    /**
+     * 权限集合
+     * @private
+     */
+    private readonly permissions;
+    /**
+     * 已认证
+     * @private
+     */
+    private authenticated;
+    /**
+     * 无效的
+     * @private
+     */
+    private invalid;
+    /**
+     * 构造函数
+     * @param datasheet 数据表
+     */
+    constructor(datasheet: UserDatasheet<Datasheet>);
+    /**
+     * 是否已认证
+     */
+    isAuthenticated(): boolean;
+    /**
+     * 设置已认证
+     * @param authenticated 已认证
+     */
+    setAuthenticated(authenticated: boolean): void;
+    /**
+     * 获取权限集合
+     */
+    getPermissions(): Set<AccessPermission>;
+    /**
+     * 获取数据表
+     */
+    getDatasheet(): UserDatasheet<Datasheet>;
+    /**
+     * 是否无效的
+     */
+    isInvalid(): boolean;
+    /**
+     * 设置无效的
+     * @param invalid 无效的
+     */
+    setInvalid(invalid: boolean): void;
+}

package/dist/access/addon.d.ts

@@ -0,0 +1,92 @@
+import type { AccessDecision, AccessPath } from './common';
+import type { AccessContext } from './context';
+import type { AccessManager } from './manager';
+import type { AccessResource } from './resource';
+/**
+ * 访问插件
+ */
+export interface AccessAddon {
+    /**
+     * 守护之前
+     * @param context 上下文
+     * @param manager 管理器
+     * @param currentPath 当前路径
+     * @param currentResource 当前资源
+     */
+    guardBefore(context: AccessContext, manager: AccessManager, currentPath: AccessPath, currentResource: AccessResource | null): void;
+    /**
+     * 守护之后
+     * @param context 上下文
+     *  @param manager 管理器
+     * @param currentPath 当前路径
+     * @param currentResource 当前资源
+     * @param currentDecision 当前决策
+     */
+    guardAfter(context: AccessContext, manager: AccessManager, currentPath: AccessPath, currentResource: AccessResource | null, currentDecision: AccessDecision): void;
+    /**
+     * 许可之前
+     * @param context 上下文
+     *  @param manager 管理器
+     * @param stayPath 停留路径
+     * @param blockPath 阻断路径
+     * @param stayResource 停留资源
+     * @param blockResource 阻断资源
+     */
+    permitBefore(context: AccessContext, manager: AccessManager, stayPath: AccessPath, blockPath: AccessPath, stayResource: AccessResource | null, blockResource: AccessResource | null): void;
+    /**
+     * 许可之后函数
+     * @param context 上下文
+     *  @param manager 管理器
+     * @param stayPath 停留路径
+     * @param blockPath 阻断路径
+     * @param stayResource 停留资源
+     * @param blockResource 阻断资源
+     */
+    permitAfter(context: AccessContext, manager: AccessManager, stayPath: AccessPath, blockPath: AccessPath, stayResource: AccessResource | null, blockResource: AccessResource | null): void;
+}
+/**
+ * 访问插件集合
+ */
+export type AccessAddons = AccessAddon[];
+/**
+ * 抽象的访问插件
+ */
+export declare abstract class AbstractAddon implements AccessAddon {
+    /**
+     * 守护之前
+     * @param context 上下文
+     * @param manager 管理器
+     * @param currentPath 当前路径
+     * @param currentResource 当前资源
+     */
+    guardBefore(context: AccessContext, manager: AccessManager, currentPath: AccessPath, currentResource: AccessResource | null): void;
+    /**
+     * 守护之后
+     * @param context 上下文
+     * @param manager 管理器
+     * @param currentPath 当前路径
+     * @param currentResource 当前资源
+     * @param currentDecision 当前决策
+     */
+    guardAfter(context: AccessContext, manager: AccessManager, currentPath: AccessPath, currentResource: AccessResource | null, currentDecision: AccessDecision): void;
+    /**
+     * 许可之前
+     * @param context 上下文
+     * @param manager 管理器
+     * @param stayPath 停留路径
+     * @param blockPath 阻断路径
+     * @param stayResource 停留资源
+     * @param blockResource 阻断资源
+     */
+    permitBefore(context: AccessContext, manager: AccessManager, stayPath: AccessPath, blockPath: AccessPath, stayResource: AccessResource | null, blockResource: AccessResource | null): void;
+    /**
+     * 许可之后函数
+     * @param context 上下文
+     * @param manager 管理器
+     * @param stayPath 停留路径
+     * @param blockPath 阻断路径
+     * @param stayResource 停留资源
+     * @param blockResource 阻断资源
+     */
+    permitAfter(context: AccessContext, manager: AccessManager, stayPath: AccessPath, blockPath: AccessPath, stayResource: AccessResource | null, blockResource: AccessResource | null): void;
+}

package/dist/access/blocker.d.ts

@@ -0,0 +1,94 @@
+import type { AccessPath } from './common';
+import type { AccessContext } from './context';
+import type { AccessResource } from './resource';
+/**
+ * 阻断处理器
+ * @param context 上下文
+ * @param currentPath 当前路径
+ * @param currentResource 当前资源
+ */
+export type BlockHandler = (context: AccessContext, currentPath: AccessPath, currentResource: AccessResource | null) => boolean;
+/**
+ * 访问阻断器
+ */
+export interface AccessBlocker {
+    /**
+     * 进行阻断
+     * @param context 上下文
+     * @param currentPath 当前路径
+     * @param currentResource 当前资源
+     */
+    block(context: AccessContext, currentPath: AccessPath, currentResource: AccessResource | null): boolean;
+    /**
+     * 注册处理器
+     * @param handler 处理器
+     */
+    register(handler: BlockHandler): void;
+    /**
+     * 注销处理器
+     * @param handler 处理器
+     */
+    unregister(handler: BlockHandler): void;
+}
+/**
+ * 单一阻断器
+ */
+export declare class SingleBlocker implements AccessBlocker {
+    /**
+     * 处理器
+     * @private
+     */
+    private handler?;
+    /**
+     * 进行阻断
+     * @param context 上下文
+     * @param currentPath 当前路径
+     * @param currentResource 当前资源
+     */
+    block(context: AccessContext, currentPath: AccessPath, currentResource: AccessResource): boolean;
+    /**
+     * 注册处理器
+     * @param handler 处理器
+     */
+    register(handler: BlockHandler): void;
+    /**
+     * 注销处理器
+     * @param handler 处理器
+     */
+    unregister(handler: BlockHandler): void;
+}
+/**
+ * 多个阻断器
+ */
+export declare class MultiBlocker implements AccessBlocker {
+    /**
+     * 处理器集合
+     * @private
+     */
+    private readonly handlers;
+    /**
+     * 构造函数
+     */
+    constructor();
+    /**
+     * 进行阻断
+     * @param context 上下文
+     * @param currentPath 当前路径
+     * @param currentResource 当前资源
+     */
+    block(context: AccessContext, currentPath: AccessPath, currentResource: AccessResource): boolean;
+    /**
+     * 注册处理器
+     * @param handler 处理器
+     */
+    register(handler: BlockHandler): void;
+    /**
+     * 注销处理器
+     * @param handler 处理器
+     */
+    unregister(handler: BlockHandler): void;
+    /**
+     * 清理处理器集合
+     */
+    clear(): void;
+}

package/dist/access/common.d.ts

@@ -0,0 +1,63 @@
+import type { Path } from '../bridge';
+/**
+ * 访问路径
+ */
+export type AccessPath = Path;
+/**
+ * 访问权限
+ */
+export type AccessPermission = string;
+/**
+ * 访问权限集合
+ */
+export type AccessPermissions = AccessPermission[];
+/**
+ * 访问决策
+ */
+export declare enum AccessDecision {
+    /**
+     * 没有资源
+     */
+    notResource = "notResource",
+    /**
+     * 没有认证
+     */
+    notAuthentication = "notAuthentication",
+    /**
+     * 无效认证
+     */
+    invalidAuthentication = "invalidAuthentication",
+    /**
+     * 没有授权
+     */
+    notAuthorization = "notAuthorization",
+    /**
+     * 没有签名
+     */
+    notSignature = "notSignature",
+    /**
+     * 访问拒绝
+     */
+    accessDenied = "accessDenied",
+    /**
+     * 允许访问
+     */
+    allowAccess = "allowAccess"
+}
+/**
+ * 访问行为
+ */
+export declare enum AccessBehave {
+    /**
+     * 什么都不做
+     */
+    doNothing = "doNothing",
+    /**
+     * 跳转导航
+     */
+    goNavigate = "goNavigate",
+    /**
+     * 重新决策
+     */
+    reDecision = "reDecision"
+}

package/dist/access/context.d.ts

@@ -0,0 +1,162 @@
+import type { AccessMatcher } from './matcher';
+import type { AccessNavigator } from './navigator';
+import type { AccessRecorder } from './recorder';
+import type { AccessStorer } from './storer';
+import type { AccessVoter } from './voter';
+/**
+ * 访问上下文
+ */
+export interface AccessContext {
+    /**
+     * 获取记录器
+     */
+    getRecorder(): AccessRecorder;
+    /**
+     * 设置记录器
+     * @param recorder 记录器
+     */
+    setRecorder(recorder: AccessRecorder): void;
+    /**
+     * 获取投票器
+     */
+    getVoter(): AccessVoter;
+    /**
+     * 设置投票器
+     * @param voter 投票器
+     */
+    setVoter(voter: AccessVoter): void;
+    /**
+     * 获取存储器
+     */
+    getStorer(): AccessStorer;
+    /**
+     * 设置存储器
+     * @param storer 存储器
+     */
+    setStorer(storer: AccessStorer): void;
+    /**
+     * 获取匹配器
+     */
+    getMatcher(): AccessMatcher;
+    /**
+     * 设置匹配器
+     * @param matcher 匹配器
+     */
+    setMatcher(matcher: AccessMatcher): void;
+    /**
+     * 获取导航器
+     */
+    getNavigator(): AccessNavigator;
+    /**
+     * 设置导航器
+     * @param navigator 导航器
+     */
+    setNavigator(navigator: AccessNavigator): void;
+    /**
+     * 获取父级
+     */
+    getParent(): AccessContext | undefined;
+    /**
+     * 设置父级
+     * @param parent 父级
+     */
+    setParent(parent: AccessContext): void;
+}
+/**
+ * 简单上下文
+ */
+export declare class SimpleContext implements AccessContext {
+    /**
+     * 记录器
+     * @private
+     */
+    private recorder;
+    /**
+     * 投票器
+     * @private
+     */
+    private voter;
+    /**
+     * 存储器
+     * @private
+     */
+    private storer;
+    /**
+     * 匹配器
+     * @private
+     */
+    private matcher;
+    /**
+     * 导航器
+     * @private
+     */
+    private navigator;
+    /**
+     * 父级
+     * @private
+     */
+    private parent?;
+    /**
+     * 构造函数
+     * @param recorder 记录器
+     * @param voter 投票器
+     * @param storer 存储器
+     * @param matcher 匹配器
+     * @param navigator 导航器
+     */
+    constructor(recorder: AccessRecorder, voter: AccessVoter, storer: AccessStorer, matcher: AccessMatcher, navigator: AccessNavigator);
+    /**
+     * 获取记录器
+     */
+    getRecorder(): AccessRecorder;
+    /**
+     * 设置记录器
+     * @param recorder 记录器
+     */
+    setRecorder(recorder: AccessRecorder): void;
+    /**
+     * 获取投票器
+     */
+    getVoter(): AccessVoter;
+    /**
+     * 设置投票器
+     * @param voter 投票器
+     */
+    setVoter(voter: AccessVoter): void;
+    /**
+     * 获取存储器
+     */
+    getStorer(): AccessStorer;
+    /**
+     * 设置存储器
+     * @param storer 存储器
+     */
+    setStorer(storer: AccessStorer): void;
+    /**
+     * 获取匹配器
+     */
+    getMatcher(): AccessMatcher;
+    /**
+     * 设置匹配器
+     * @param matcher 匹配器
+     */
+    setMatcher(matcher: AccessMatcher): void;
+    /**
+     * 获取导航器
+     */
+    getNavigator(): AccessNavigator;
+    /**
+     * 设置导航器
+     * @param navigator 导航器
+     */
+    setNavigator(navigator: AccessNavigator): void;
+    /**
+     * 获取父级
+     */
+    getParent(): AccessContext | undefined;
+    /**
+     * 设置父级
+     * @param parent 父级
+     */
+    setParent(parent?: AccessContext): void;
+}