f2e-server3/lib/middlewares/auth/interface.d.ts

f2e-server 3.0

import { Cookie } from "../../utils/cookie";
/** 登录用户信息 */
export interface LoginUser {
    /** 登录用户名 */
    username: string;
    /** 用户展示名称 */
    nickname?: string;
}
/** 登录用户信息 */
export interface LoginInfo {
    /** 登录用户完成设置token */
    token: string;
    user?: LoginUser;
    /** 最后访问url */
    last_url: string;
    /** token 在服务端的失效日期 */
    expire: number;
    /** 当前登录的ip */
    ip: string;
    /** 当前登录的ua */
    ua: string;
}
export interface IUserStore {
    /** 查询登录用户信息 */
    getUser(username: string, password: string): Promise<LoginUser | undefined>;
    /** 直接通过token查询登录用户信息 */
    getLoginUser(crsf_token?: string): Promise<LoginUser | undefined>;
    /** 非必须，如果有定义，当删除用户时，同步清空已经登录的用户信息 */
    onDeleteUser?(callback: (username: string) => void): void;
}
export interface AuthConfig {
    /** 登录路径，登录成功后登录信息可以从 login_path + '/info' 获取
     * @default 'login'
    */
    login_path?: string;
    /** 登出路径
     * @default 'logout'
    */
    logout_path?: string;
    /**
     * 登录页面内容
     * 可参考 [page_login.hbs](../../../templates/page_login.hbs)
     * */
    login_page?: string;
    /**
     * 账户提交加密算法, 需要跟登录页面的算法保持一致
     * 可参考 [auth/index.ts](./index.ts)
     */
    decrypt_account?: (account: string, token: string) => {
        username: string;
        password: string;
    } | null;
    /**
     * 登录成功是否跳转原路径
     * 设置为 true 跳转原路径
     * 设置为 字符串 表示直接跳转的路径
     * @default '/'
     */
    redirect?: true | string;
    /**
     * 白名单, 跳过鉴权，正则字符串
     */
    white_list?: string[];
    /**
     * 忽略记录，正则字符串
     * 说明：正常记录所有访问请求作为登录后跳转的路径,如需要忽略,使用此配置
     * @default ["[.](js|css|svg|ico|png|gif|jpe?g)$", "^(api|login|logout)"]
     */
    record_ignores?: string[];
    /**
     * 允许最多登录客户端数量
     * 新登录客户端会把最早登录挤掉
     * @default 1
    */
    max_login_count?: number;
    /**
     * 允许最大错误次数
     * @default 5
     */
    max_error_count?: number;
    /**
     * 用户存储引擎
     */
    store?: IUserStore;
    /**
     * 登录信息缓存目录
     * @default process.cwd() + '/.f2e_cache'
     */
    cache_root?: string;
    messages?: {
        crsf_token_not_found?: string;
        crsf_token_invalid?: string;
        account_not_found?: string;
        ip_error_count_exceed?: string;
    };
    /**
     * cookie设置配置
     * @default { name: 'f2e_auth', options: { maxAge: 60 * 60 * 24 * 7, httpOnly: true, secure: true, sameSite: 'strict' } }
     */
    cookie?: Omit<Cookie, 'value'>;
}