mm_session 1.5.2 → 1.5.3

package/README.md

@@ -1,20 +1,23 @@
 # mm_session
 
-[English Documentation](./README_EN.md) | [中文文档](./README.md)
+[中文](./README.md) | [English](./README_EN.md)
 
 ## 概述
 
 `mm_session` 是一个专为 Koa.js 框架设计的轻量级 session 管理中间件。它提供了简单易用的 session 管理功能，支持自定义存储后端，适用于各种规模的 Web 应用。
 
+这是超级美眉session函数模块，用于web服务端session缓存。
+
 ## 特性
 
-- ✅ **Koa 中间件标准** - 符合 `app.use(session.middleware())` 使用方式
+- ✅ **Koa 中间件标准** - 符合 `app.use(session({ key: 'test_session', max_age: 3600 }))` 使用方式
 - ✅ **存储抽象层** - 支持自定义存储后端
 - ✅ **自动 session 管理** - 自动创建、保存、销毁 session
 - ✅ **Cookie 自动处理** - 自动设置和读取 session cookie
 - ✅ **安全 session ID** - 基于 IP + 时间戳 + AES 加密生成
 - ✅ **异步支持** - 完整的 async/await 支持
 - ✅ **轻量级** - 无冗余依赖，代码简洁
+- ✅ **生产就绪** - 经过充分测试，稳定可靠
 
 ## 安装
 
@@ -28,18 +31,15 @@ npm install mm_session
 
 ```javascript
 const Koa = require('koa');
-const { Session } = require('mm_session');
+const { session } = require('mm_session');
 
 const app = new Koa();
 
-// 创建 session 实例
-const session = new Session({
+// 注册中间件
+app.use(session({
   key: 'my_session',      // cookie 名称
   max_age: 3600          // session 过期时间（秒）
-});
-
-// 注册中间件
-app.use(session.middleware());
+}));
 
 // 业务路由
 app.use(async (ctx) => {
@@ -235,18 +235,45 @@ mm_session/
 
 ## 贡献
 
-欢迎提交 Issue 和 Pull Request！
+欢迎贡献！请随时提交 Issue 和 Pull Request。
+
+### 开发环境设置
+
+1. 克隆仓库：
+```bash
+git clone https://gitee.com/qiuwenwu91/mm_session.git
+cd mm_session
+```
+
+2. 安装依赖：
+```bash
+npm install
+```
+
+3. 运行测试：
+```bash
+npm test
+```
 
 ## 许可证
 
 ISC License
 
+版权所有 (c) 2024 邱文武
+
+特此免费授予任何获得本软件副本和相关文档文件（以下简称"软件"）的人不受限制地处理本软件的权限，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售本软件的副本，以及允许提供本软件的人员这样做，但须符合以下条件：
+
+上述版权声明和本许可声明应包含在本软件的所有副本或重要部分中。
+
 ## 作者
 
 邱文武
 
 ## 更新日志
 
+### v1.5.3
+- 当前稳定版本
+
 ### v1.5.1
 - 修复 session 保存逻辑
 - 优化 cookie 设置机制
@@ -257,7 +284,15 @@ ISC License
 - 符合 Koa 中间件标准使用方式
 - 增强代码可维护性
 
+## 错误报告
+
+如果您遇到任何错误或有功能请求，请在 [Git 仓库](https://gitee.com/qiuwenwu91/mm_session/issues) 上提交 Issue。
+
 ## 相关项目
 
-- [mm_cachebase](https://www.npmjs.com/package/mm_cachebase) - 缓存基础库
-- [mm_eslint](https://www.npmjs.com/package/mm_eslint) - ESLint 配置
+- [mm_cache](https://www.npmjs.com/package/mm_cache) - 缓存库（依赖项）
+- [mm_eslint](https://www.npmjs.com/package/mm_eslint) - ESLint 配置（开发依赖项）
+
+## 支持
+
+如需支持和问题解答，请查阅文档或在项目仓库中创建 Issue。

package/README_EN.md

@@ -1,20 +1,23 @@
 # mm_session
 
-[English Documentation](README_EN.md) | [中文文档](README.md)
+[中文](README.md) | [English](README_EN.md)
 
 ## Overview
 
 `mm_session` is a lightweight session management middleware designed specifically for the Koa.js framework. It provides simple and easy-to-use session management functionality with support for custom storage backends, suitable for web applications of all sizes.
 
+This is a super session function module for web server-side session caching.
+
 ## Features
 
-- ✅ **Koa Middleware Standard** - Compatible with `app.use(session.middleware())` usage
+- ✅ **Koa Middleware Standard** - Compatible with `app.use(session({ key: 'test_session', max_age: 3600 }))` usage
 - ✅ **Storage Abstraction Layer** - Supports custom storage backends
 - ✅ **Automatic Session Management** - Automatic session creation, saving, and destruction
 - ✅ **Cookie Auto-handling** - Automatic session cookie setting and reading
 - ✅ **Secure Session ID** - Generated based on IP + timestamp + AES encryption
 - ✅ **Async Support** - Full async/await support
 - ✅ **Lightweight** - No redundant dependencies, clean codebase
+- ✅ **Production Ready** - Well-tested and stable for production use
 
 ## Installation
 
@@ -28,18 +31,15 @@ npm install mm_session
 
 ```javascript
 const Koa = require('koa');
-const { Session } = require('mm_session');
+const { session } = require('mm_session');
 
 const app = new Koa();
 
-// Create session instance
-const session = new Session({
+// Register middleware
+app.use(session({
   key: 'my_session',      // cookie name
   max_age: 3600          // session expiration time (seconds)
-});
-
-// Register middleware
-app.use(session.middleware());
+}));
 
 // Business routes
 app.use(async (ctx) => {
@@ -235,18 +235,43 @@ mm_session/
 
 ## Contributing
 
-Issues and Pull Requests are welcome!
+We welcome contributions! Please feel free to submit issues and pull requests.
+
+### Development Setup
+
+1. Clone the repository:
+```bash
+git clone https://gitee.com/qiuwenwu91/mm_session.git
+cd mm_session
+```
+
+2. Install dependencies:
+```bash
+npm install
+```
+
+3. Run tests:
+```bash
+npm test
+```
 
 ## License
 
 ISC License
 
+Copyright (c) 2024 Qiu Wenwu
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
 ## Author
 
 Qiu Wenwu
 
 ## Changelog
 
+### v1.5.3
+- Current stable version
+
 ### v1.5.1
 - Fixed session saving logic
 - Optimized cookie setting mechanism
@@ -257,7 +282,15 @@ Qiu Wenwu
 - Compatible with Koa middleware standard usage
 - Enhanced code maintainability
 
+## Bug Reports
+
+If you encounter any bugs or have feature requests, please file an issue on the [Git repository](https://gitee.com/qiuwenwu91/mm_session/issues).
+
 ## Related Projects
 
-- [mm_cachebase](https://www.npmjs.com/package/mm_cachebase) - Cache base library
-- [mm_eslint](https://www.npmjs.com/package/mm_eslint) - ESLint configuration
+- [mm_cache](https://www.npmjs.com/package/mm_cache) - Cache library (dependency)
+- [mm_eslint](https://www.npmjs.com/package/mm_eslint) - ESLint configuration (dev dependency)
+
+## Support
+
+For support and questions, please check the documentation or create an issue on the project repository.

package/eslint.config.js

@@ -27,13 +27,13 @@ module.exports = [
     rules: {
       // 自定义命名规范插件规则（优先使用）
       'naming-convention/class-name': 'error',
-      'naming-convention/function-name': 'off', // 禁用函数命名规则，私有方法以下划线开头
+      'naming-convention/function-name': 'error', // 启用函数命名规则
       'naming-convention/method-name': 'error',
       'naming-convention/variable-name': 'warn',
       'naming-convention/constant-name': 'error',
       'naming-convention/private-method-naming': 'warn',
       'naming-convention/private-variable-naming': 'warn',
-      'naming-convention/param-name': 'off', // 禁用入参名规则，私有方法入参以下划线开头
+      'naming-convention/param-name': 'error', // 启用入参名规则
       'naming-convention/property-name': 'warn',
       'naming-convention/instance-property': 'warn',
       
@@ -102,8 +102,7 @@ module.exports = [
     rules: {
       // 必须进行参数校验
       'no-unused-vars': ['error', {
-        args: 'all',
-        argsIgnorePattern: '^_',
+        args: 'none', // 不检查未使用的参数
         caughtErrors: 'all',
         caughtErrorsIgnorePattern: '^_',
         destructuredArrayIgnorePattern: '^_',

package/index.js

@@ -1,10 +1,11 @@
 const { Store } = require('./lib/store.js');
 const { Session } = require('./lib/session.js');
 
-let session = new Session();
-
 module.exports = {
   Session,
   Store,
-  session
+  session: function(config) {
+    let session = new Session(config);
+    return session.middleware();
+  }
 };

package/lib/helper.js

@@ -0,0 +1,99 @@
+const crypto = require('crypto');
+
+/**
+ * 帮助类
+ */
+class Helper {
+  /**
+   * 构造函数
+   */
+  constructor() {
+  }
+}
+
+/**
+ * AES编码字符串
+ * @param {string} text 输入文本
+ * @param {string} key 编码密钥
+ * @param {string} iv 初始化向量
+ * @returns {string} 编码后的字符串
+ */
+Helper.prototype.aesEncode = function (text, key, iv) {
+  // 1. 创建cipher对象
+  const cipher = crypto.createCipheriv('aes-128-cbc', key, iv);
+  // 2. 更新加密数据
+  let enc = cipher.update(text, 'utf8', 'hex');
+  // 3. 完成加密
+  enc += cipher.final('hex');
+  return enc;
+};
+
+/**
+ * AES解码字符串
+ * @param {string} text - 输入文本
+ * @param {string} key - 解码密钥
+ * @param {string} iv - 初始化向量
+ * @returns {string} 解码后的字符串
+ */
+Helper.prototype.aesDecode = function (text, key, iv) {
+  // 1. 创建decipher对象
+  const decipher = crypto.createDecipheriv('aes-128-cbc', key, iv);
+  // 2. 更新解密数据
+  let dec = decipher.update(text, 'hex', 'utf8');
+  // 3. 完成解密
+  dec += decipher.final('utf8');
+  return dec;
+};
+
+
+/**
+ * 生成session ID的密钥
+ * @param {string} user_agent 用户代理字符串
+ * @returns {string} 密钥
+ */
+Helper.prototype._getSecret = function (user_agent = 'mm') {
+  // md5方法由mm_expand模块提供
+  return user_agent.md5().substring(0, 16);
+};
+
+/**
+ * 生成session ID
+ * @param {string} key 密钥
+ * @param {string} ip 客户端IP
+ * @param {string} user_agent 用户代理字符串
+ * @param {number} uuid_expire 过期时间（秒）
+ * @returns {string} session ID
+ */
+Helper.prototype.genId = function (key, ip, user_agent = 'mm', uuid_expire = 604800) {
+  // 生成session ID的初始化向量
+  var iv = this._getSecret(user_agent);
+  var end_time = new Date().addSeconds(uuid_expire).stamp();
+  // 加密
+  var uuid = this.aesEncode(ip + '_' + end_time, key, iv);
+  return uuid;
+};
+
+/**
+ * 解析session ID
+ * @param {string} key 密钥
+ * @param {string} uuid session ID
+ * @param {string} user_agent 用户代理字符串
+ * @returns {object} 解析结果
+ */
+Helper.prototype.parseId = function (key, uuid, user_agent = 'mm') {
+  // 生成session ID的初始化向量
+  var iv = this._getSecret(user_agent);
+  // 解密
+  var dec = this.aesDecode(uuid, key, iv);
+  // 解析IP和过期时间
+  var ip = dec.split('_')[0];
+  var end_time = dec.split('_')[1];
+  return {
+    ip,
+    end_time
+  };
+};
+
+module.exports = {
+  Helper
+};