@lanaqi/rsr 0.0.1-rc.0

package/dist/access/recorder.d.ts

@@ -0,0 +1,291 @@
+import type { AccessAuthentication, AccessAuthorization } from './aaa';
+import type { AccessPath } from './common';
+import type { AccessResource } from './resource';
+/**
+ * 访问记录器
+ */
+export interface AccessRecorder {
+    /**
+     * 获取当前路径
+     */
+    getCurrentPath(): AccessPath | undefined;
+    /**
+     * 设置当前路径
+     * @param currentPath 当前路径
+     */
+    setCurrentPath(currentPath: AccessPath): void;
+    /**
+     * 存在当前路径
+     */
+    existCurrentPath(): boolean;
+    /**
+     * 是否当前路径名
+     * @param pathname 路径名
+     */
+    isCurrentPath(pathname: string): boolean;
+    /**
+     * 是否当前路径名集合
+     * @param pathnames 路径名集合
+     */
+    isCurrentPaths(...pathnames: string[]): boolean;
+    /**
+     * 获取允许路径
+     */
+    getAllowPath(): AccessPath | undefined;
+    /**
+     * 设置允许路径
+     * @param allowPath 允许路径
+     */
+    setAllowPath(allowPath: AccessPath): void;
+    /**
+     * 存在允许路径
+     */
+    existAllowPath(): boolean;
+    /**
+     * 是否允许路径名
+     * @param pathname 路径名
+     */
+    isAllowPath(pathname: string): boolean;
+    /**
+     * 是否允许路径名集合
+     * @param pathnames 路径名集合
+     */
+    isAllowPaths(...pathnames: string[]): boolean;
+    /**
+     * 获取原始路径
+     */
+    getOriginPath(): AccessPath | undefined;
+    /**
+     * 设置原始路径
+     * @param originPath 原始路径
+     */
+    setOriginPath(originPath: AccessPath): void;
+    /**
+     * 存在原始路径
+     */
+    existOriginPath(): boolean;
+    /**
+     * 是否原始路径名
+     * @param pathname 路径名
+     */
+    isOriginPath(pathname: string): boolean;
+    /**
+     * 是否原始路径名集合
+     * @param pathnames 路径名集合
+     */
+    isOriginPaths(...pathnames: string[]): boolean;
+    /**
+     * 获取访问资源
+     */
+    getAccessResource(): AccessResource | undefined;
+    /**
+     * 设置访问资源
+     * @param accessResource 访问资源
+     */
+    setAccessResource(accessResource: AccessResource): void;
+    /**
+     * 存在访问资源
+     */
+    existAccessResource(): boolean;
+    /**
+     * 获取访问认证
+     */
+    getAccessAuthentication(): AccessAuthentication | undefined;
+    /**
+     * 设置访问认证
+     * @param accessAuthentication 访问认证
+     */
+    setAccessAuthentication(accessAuthentication: AccessAuthentication): void;
+    /**
+     * 存在访问认证
+     */
+    existAccessAuthentication(): boolean;
+    /**
+     * 获取访问授权
+     */
+    getAccessAuthorization(): AccessAuthorization | undefined;
+    /**
+     * 设置访问授权
+     * @param accessAuthorization 访问授权
+     */
+    setAccessAuthorization(accessAuthorization: AccessAuthorization): void;
+    /**
+     * 存在访问授权
+     */
+    existAccessAuthorization(): boolean;
+    /**
+     * 清理原始路径
+     */
+    clearOriginPath(): void;
+    /**
+     * 清理访问资源
+     */
+    clearAccessResource(): void;
+    /**
+     * 清理访问认证
+     */
+    clearAccessAuthentication(): void;
+    /**
+     * 清理访问授权
+     */
+    clearAccessAuthorization(): void;
+}
+/**
+ * 简单记录器
+ */
+export declare class SimpleRecorder implements AccessRecorder {
+    /**
+     * 当前路径
+     * @private
+     */
+    private currentPath?;
+    /**
+     * 允许路径
+     * @private
+     */
+    private allowPath?;
+    /**
+     * 原始路径
+     * @private
+     */
+    private originPath?;
+    /**
+     * 访问资源
+     * @private
+     */
+    private accessResource?;
+    /**
+     * 访问认证
+     * @private
+     */
+    private accessAuthentication?;
+    /**
+     * 访问授权
+     * @private
+     */
+    private accessAuthorization?;
+    /**
+     * 获取当前路径
+     */
+    getCurrentPath(): AccessPath | undefined;
+    /**
+     * 设置当前路径
+     * @param currentPath 当前路径
+     */
+    setCurrentPath(currentPath: AccessPath): void;
+    /**
+     * 存在当前路径
+     */
+    existCurrentPath(): boolean;
+    /**
+     * 是否当前路径名
+     * @param pathname 当前路径名
+     */
+    isCurrentPath(pathname: string): boolean;
+    /**
+     * 是否当前路径名集合
+     * @param pathnames 路径名集合
+     */
+    isCurrentPaths(...pathnames: string[]): boolean;
+    /**
+     * 获取允许路径
+     */
+    getAllowPath(): AccessPath | undefined;
+    /**
+     * 设置允许路径
+     * @param allowPath 允许路径
+     */
+    setAllowPath(allowPath: AccessPath): void;
+    /**
+     * 存在允许路径
+     */
+    existAllowPath(): boolean;
+    /**
+     * 是否允许路径名
+     * @param pathname 允许路径名
+     */
+    isAllowPath(pathname: string): boolean;
+    /**
+     * 是否允许路径名集合
+     * @param pathnames 路径名集合
+     */
+    isAllowPaths(...pathnames: string[]): boolean;
+    /**
+     * 获取原始路径
+     */
+    getOriginPath(): AccessPath | undefined;
+    /**
+     * 设置原始路径
+     * @param originPath 原始路径
+     */
+    setOriginPath(originPath: AccessPath): void;
+    /**
+     * 存在原始路径
+     */
+    existOriginPath(): boolean;
+    /**
+     * 是否原始路径名
+     * @param pathname 路径名
+     */
+    isOriginPath(pathname: string): boolean;
+    /**
+     * 是否原始路径名集合
+     * @param pathnames 路径名集合
+     */
+    isOriginPaths(...pathnames: string[]): boolean;
+    /**
+     * 获取访问资源
+     */
+    getAccessResource(): AccessResource | undefined;
+    /**
+     * 设置访问资源
+     * @param accessResource 访问资源
+     */
+    setAccessResource(accessResource: AccessResource): void;
+    /**
+     * 存在访问资源
+     */
+    existAccessResource(): boolean;
+    /**
+     * 获取访问认证
+     */
+    getAccessAuthentication(): AccessAuthentication | undefined;
+    /**
+     * 设置访问认证
+     * @param accessAuthentication 访问认证
+     */
+    setAccessAuthentication(accessAuthentication: AccessAuthentication): void;
+    /**
+     * 存在访问认证
+     */
+    existAccessAuthentication(): boolean;
+    /**
+     * 获取访问授权
+     */
+    getAccessAuthorization(): AccessAuthorization | undefined;
+    /**
+     * 设置访问授权
+     * @param accessAuthorization 访问授权
+     */
+    setAccessAuthorization(accessAuthorization: AccessAuthorization): void;
+    /**
+     * 存在访问授权
+     */
+    existAccessAuthorization(): boolean;
+    /**
+     * 清理原始路径
+     */
+    clearOriginPath(): void;
+    /**
+     * 清理访问资源
+     */
+    clearAccessResource(): void;
+    /**
+     * 清理访问认证
+     */
+    clearAccessAuthentication(): void;
+    /**
+     * 清理访问授权
+     */
+    clearAccessAuthorization(): void;
+}

package/dist/access/resource.d.ts

@@ -0,0 +1,215 @@
+import type { PathPattern } from '../bridge';
+import type { AccessPermission, AccessPermissions } from './common';
+/**
+ * 资源模式
+ */
+export type ResourcePattern = PathPattern<string> | string;
+/**
+ * 资源模式集合
+ */
+export type ResourcePatterns = ResourcePattern[];
+/**
+ * 资源标签
+ */
+export type ResourceLabel = string;
+/**
+ * 资源标签集合
+ */
+export type ResourceLabels = ResourceLabel[];
+/**
+ * 访问资源
+ */
+export interface AccessResource {
+    /**
+     * 获取模式集合
+     */
+    getPatterns(): Set<ResourcePattern>;
+    /**
+     * 获取权限集合
+     */
+    getPermissions(): Set<AccessPermission>;
+    /**
+     * 获取标签集合
+     */
+    getLabels(): Set<ResourceLabel>;
+    /**
+     * 是否包含模式
+     * @param pattern 模式
+     */
+    hasPattern(pattern: ResourcePattern): boolean;
+    /**
+     * 是否包含权限
+     * @param permission 权限
+     */
+    hasPermission(permission: AccessPermission): boolean;
+    /**
+     * 是否包含标签
+     * @param label 标签
+     */
+    hasLabel(label: ResourceLabel): boolean;
+    /**
+     * 是否匿名的
+     */
+    isAnonymous(): boolean;
+    /**
+     * 是否已认证
+     */
+    isAuthenticated(): boolean;
+    /**
+     * 是否已授权
+     */
+    isAuthorized(): boolean;
+    /**
+     * 是否已签名
+     */
+    isSignatured(): boolean;
+    /**
+     * 是否始终签名
+     */
+    isAlwaysSignature(): boolean;
+    /**
+     * 获取基础路径
+     */
+    getBasename(): string | undefined;
+    /**
+     * 设置基础路径
+     */
+    setBasename(basename: string | undefined): void;
+}
+/**
+ * 访问资源集合
+ */
+export type AccessResources = AccessResource[];
+/**
+ * 简单资源
+ */
+export declare class SimpleResource implements AccessResource {
+    /**
+     * 权限：匿名的
+     */
+    static readonly PERMISSION_ANONYMOUS = "__anonymous__";
+    /**
+     * 权限：已认证
+     */
+    static readonly PERMISSION_AUTHENTICATED = "__authenticated__";
+    /**
+     * 权限：已授权
+     */
+    static readonly PERMISSION_AUTHORIZED = "__authorized__";
+    /**
+     * 标签：已签名
+     */
+    static readonly LABEL_SIGNATURED = "__signatured__";
+    /**
+     * 标签：始终签名
+     */
+    static readonly LABEL_ALWAYS_SIGNATURE = "__always_signature__";
+    /**
+     * 模式集合
+     * @private
+     */
+    private readonly patterns;
+    /**
+     * 权限集合
+     * @private
+     */
+    private readonly permissions;
+    /**
+     * 标签集合
+     * @private
+     */
+    private readonly labels;
+    /**
+     * 匿名的
+     * @private
+     */
+    private readonly anonymous;
+    /**
+     * 已认证
+     * @private
+     */
+    private readonly authenticated;
+    /**
+     * 已授权
+     * @private
+     */
+    private readonly authorized;
+    /**
+     * 已签名
+     * @private
+     */
+    private readonly signatured;
+    /**
+     * 始终签名
+     * @private
+     */
+    private readonly alwaysSignature;
+    /**
+     * 基础路径
+     * @private
+     */
+    private basename?;
+    /**
+     * 构造函数
+     * @param patterns 模式集合
+     * @param permissions 权限集合
+     * @param labels 标签集合
+     * @param basename 基础路径
+     */
+    constructor(patterns: ResourcePatterns | Set<ResourcePattern>, permissions: AccessPermissions | Set<AccessPermission>, labels: ResourceLabels | Set<ResourceLabel>, basename?: string);
+    /**
+     * 获取模式集合
+     */
+    getPatterns(): Set<ResourcePattern>;
+    /**
+     * 获取权限集合
+     */
+    getPermissions(): Set<AccessPermission>;
+    /**
+     * 获取标签集合
+     */
+    getLabels(): Set<ResourceLabel>;
+    /**
+     * 是否包含模式
+     * @param pattern 模式
+     */
+    hasPattern(pattern: ResourcePattern): boolean;
+    /**
+     * 是否包含权限
+     * @param permission 权限
+     */
+    hasPermission(permission: AccessPermission): boolean;
+    /**
+     * 是否包含标签
+     * @param label 标签
+     */
+    hasLabel(label: ResourceLabel): boolean;
+    /**
+     * 是否匿名的
+     */
+    isAnonymous(): boolean;
+    /**
+     * 是否已认证
+     */
+    isAuthenticated(): boolean;
+    /**
+     * 是否已授权
+     */
+    isAuthorized(): boolean;
+    /**
+     * 是否已签名
+     */
+    isSignatured(): boolean;
+    /**
+     * 是否始终签名
+     */
+    isAlwaysSignature(): boolean;
+    /**
+     * 获取基础路径
+     */
+    getBasename(): string | undefined;
+    /**
+     * 设置基础路径
+     */
+    setBasename(basename: string | undefined): void;
+}

package/dist/access/storer.d.ts

@@ -0,0 +1,197 @@
+import { type AccessAuthentication, type AccessAuthorization, type AccessDatasheet, type AuthenticationDatasheet, type AuthorizationDatasheet } from './aaa';
+import type { AccessPath } from './common';
+import type { AccessRecorder } from './recorder';
+/**
+ * 访问存储器
+ */
+export interface AccessStorer {
+    /**
+     * 加载认证
+     * @param recorder 记录器
+     */
+    loadAuthentication(recorder: AccessRecorder): AccessAuthentication | undefined;
+    /**
+     * 校验认证
+     * @param recorder 记录器
+     * @param authentication 认证
+     */
+    verifyAuthentication(recorder: AccessRecorder, authentication: AccessAuthentication): boolean;
+    /**
+     * 删除认证
+     * @param recorder 记录器
+     */
+    deleteAuthentication(recorder: AccessRecorder): void;
+    /**
+     * 保存认证
+     * @param recorder 记录器
+     * @param datasheet 数据表
+     */
+    saveAuthentication<Datasheet>(recorder: AccessRecorder, datasheet: AccessDatasheet<AuthenticationDatasheet<Datasheet>>): void;
+    /**
+     * 加载授权
+     * @param recorder 记录器
+     * @param authentication 认证 | undefined
+     */
+    loadAuthorization(recorder: AccessRecorder, authentication: AccessAuthentication | undefined): AccessAuthorization | undefined;
+    /**
+     * 删除授权
+     * @param recorder 记录器
+     */
+    deleteAuthorization(recorder: AccessRecorder): void;
+    /**
+     * 保存授权
+     * @param recorder 记录器
+     * @param datasheet 数据表
+     */
+    saveAuthorization<Datasheet>(recorder: AccessRecorder, datasheet: AccessDatasheet<AuthorizationDatasheet<Datasheet>>): void;
+    /**
+     * 加载签名
+     * @param recorder 记录器
+     * @param path 路径
+     * @param authentication 认证
+     * @param authorization 授权
+     */
+    loadSignature(recorder: AccessRecorder, path: AccessPath, authentication: AccessAuthentication, authorization: AccessAuthorization): boolean;
+    /**
+     * 移除签名
+     * @param recorder 记录器
+     * @param path 路径
+     */
+    removeSignature(recorder: AccessRecorder, path: AccessPath): void;
+    /**
+     * 删除签名
+     * @param recorder 记录器
+     */
+    deleteSignature(recorder: AccessRecorder): void;
+    /**
+     * 保存签名
+     * @param recorder 记录器
+     * @param path 路径
+     */
+    saveSignature(recorder: AccessRecorder, path: AccessPath): void;
+}
+/**
+ * 访问验证器
+ */
+export type AccessValidator = (recorder: AccessRecorder, authentication: AccessAuthentication) => boolean;
+/**
+ * 简单存储器
+ */
+export declare class SimpleStorer implements AccessStorer {
+    /**
+     * 存储健：认证
+     */
+    static readonly KEY_AUTHENTICATION = "__authentication__";
+    /**
+     * 存储健：授权
+     */
+    static readonly KEY_AUTHORIZATION = "__authorization__";
+    /**
+     * 存储健：签名
+     */
+    static readonly KEY_SIGNATURE = "__signature__";
+    /**
+     * 认证与授权存储
+     * @private
+     */
+    private readonly aaaStorage;
+    /**
+     * 签名存储
+     * @private
+     */
+    private readonly signStorage;
+    /**
+     * 认证健
+     * @private
+     */
+    private readonly authenticationKey;
+    /**
+     * 授权健
+     * @private
+     */
+    private readonly authorizationKey;
+    /**
+     * 签名健
+     * @private
+     */
+    private readonly signatureKey;
+    /**
+     * 认证验证器
+     * @private
+     */
+    private readonly authenticationValidator?;
+    /**
+     * 构造函数
+     * @param aaaStorage 认证与授权存储
+     * @param signStorage 签名存储
+     * @param authenticationKey 认证健
+     * @param authorizationKey 授权健
+     * @param signatureKey 签名健
+     * @param authenticationValidator 认证验证器
+     */
+    constructor(aaaStorage: Storage, signStorage: Storage, authenticationKey?: string, authorizationKey?: string, signatureKey?: string, authenticationValidator?: AccessValidator);
+    /**
+     * 加载认证
+     * @param recorder 记录器
+     */
+    loadAuthentication(recorder: AccessRecorder): AccessAuthentication | undefined;
+    /**
+     * 校验认证
+     * @param recorder 记录器
+     * @param authentication 认证
+     */
+    verifyAuthentication(recorder: AccessRecorder, authentication: AccessAuthentication): boolean;
+    /**
+     * 删除认证
+     * @param recorder 记录器
+     */
+    deleteAuthentication(recorder: AccessRecorder): void;
+    /**
+     * 保存认证
+     * @param recorder 记录器
+     * @param datasheet 数据表
+     */
+    saveAuthentication<Datasheet>(recorder: AccessRecorder, datasheet: AccessDatasheet<AuthenticationDatasheet<Datasheet>>): void;
+    /**
+     * 加载授权
+     * @param recorder 记录器
+     * @param authentication 认证 | undefined
+     */
+    loadAuthorization(recorder: AccessRecorder, authentication: AccessAuthentication | undefined): AccessAuthorization | undefined;
+    /**
+     * 删除授权
+     * @param recorder 记录器
+     */
+    deleteAuthorization(recorder: AccessRecorder): void;
+    /**
+     * 保存授权
+     * @param recorder 记录器
+     * @param datasheet 数据表
+     */
+    saveAuthorization<Datasheet>(recorder: AccessRecorder, datasheet: AccessDatasheet<AuthorizationDatasheet<Datasheet>>): void;
+    /**
+     * 加载签名
+     * @param recorder 记录器
+     * @param path 路径
+     * @param authentication 认证
+     * @param authorization 授权
+     */
+    loadSignature(recorder: AccessRecorder, path: AccessPath, authentication: AccessAuthentication, authorization: AccessAuthorization): boolean;
+    /**
+     * 移除签名
+     * @param recorder 记录器
+     * @param path 路径
+     */
+    removeSignature(recorder: AccessRecorder, path: AccessPath): void;
+    /**
+     * 删除签名
+     * @param recorder 记录器
+     */
+    deleteSignature(recorder: AccessRecorder): void;
+    /**
+     * 保存签名
+     * @param recorder 记录器
+     * @param path 路径
+     */
+    saveSignature(recorder: AccessRecorder, path: AccessPath): void;
+}