Sails-Permissions 项目教程

Sails-Permissions 项目教程

sails-permissions Comprehensive user permissions and entitlements system for sails.js and Waterline. Supports user authentication with passport.js, role-based permissioning, object ownership, and row-level security. 项目地址: https://gitcode.com/gh_mirrors/sa/sails-permissions

1. 项目介绍

Sails-Permissions 是一个针对 Sails.js 框架精心设计的权限管理和认证系统。它基于 Node.js 和 Express，充分利用了 Sails.js 的 Model-View-Controller (MVC) 架构。Sails-Permissions 提供了以下核心功能：

• 角色（Roles）：定义不同级别的权限，如管理员、普通用户等。
• 权限（Permissions）：允许或禁止特定角色对资源执行特定操作。
• 策略（Policies）：基于中间件的机制，用于实现细粒度的路由访问控制。
• 审计日志（Audit Logging）：记录所有权限相关的变化，便于跟踪与审核。

该库还集成了 Waterline ORM，提供了一种抽象的数据存储方式，兼容多种数据库，包括 MySQL、PostgreSQL、MongoDB 等。

2. 项目快速启动

安装

首先，通过 npm 安装 sails-permissions 和 sails-auth：

npm install sails-permissions sails-auth --save

配置

1. 配置 sailsrc 文件：

   在项目根目录下创建或编辑 .sailsrc 文件，添加以下内容：

   {
     "generators": {
       "modules": {
         "permissions-api": "sails-permissions/generator"
       }
     }
   }
   

2. 运行生成器：

   运行以下命令生成权限 API：

   sails generate permissions-api
   

3. 设置环境变量：

   在 config/local.js 文件中设置管理员用户信息（该文件已被 .gitignore 忽略）：

   sails.config.permissions.adminUsername = 'admin';
   sails.config.permissions.adminEmail = 'admin@example.com';
   sails.config.permissions.adminPassword = 'admin1234';
   

4. 更新配置文件：

   编辑 config/policies.js 文件，添加以下策略配置：

   module.exports.policies = {
     '*': [
       'basicAuth',
       'passport',
       'sessionAuth',
       'ModelPolicy',
       'AuditPolicy',
       'OwnerPolicy',
       'PermissionPolicy',
       'RolePolicy',
       'CriteriaPolicy'
     ],
     AuthController: {
       '*': ['passport']
     }
   };
   

5. 登录：

   使用默认的管理员信息或你设置的信息，通过 /auth/local 端点进行登录：

   {
     "identifier": "admin@example.com",
     "password": "admin1234"
   }
   

3. 应用案例和最佳实践

应用场景

Sails-Permissions 可广泛应用于需要复杂权限控制的 Web 应用中，例如：

• 社交网络平台：区分用户可以查看或交互的内容。
• 内容管理系统：管理谁可以创建、编辑或删除文章。
• 企业级应用：设定不同部门或岗位对数据的访问权限。

最佳实践

• 模块化设计：根据应用需求，灵活配置角色、权限和策略。
• 审计日志：启用审计日志功能，确保所有权限变更可追溯。
• RESTful API：利用 Sails-Permissions 提供的 RESTful API 动态管理权限。

4. 典型生态项目

Sails-Auth

Sails-Auth 是一个基于 Passport.js 的用户认证系统，与 Sails-Permissions 无缝集成，提供用户注册、登录、密码重置等功能。

Waterline ORM

Waterline 是 Sails.js 的默认 ORM，支持多种数据库，包括 MySQL、PostgreSQL、MongoDB 等。Sails-Permissions 利用 Waterline 进行数据存储和查询。

Passport.js

Passport.js 是一个灵活的认证中间件，支持多种认证策略，如本地认证、OAuth 等。Sails-Permissions 使用 Passport.js 进行用户认证。

通过这些生态项目的集成，Sails-Permissions 提供了一个全面的解决方案，帮助开发人员快速搭建安全且易于维护的权限控制系统。

sails-permissions Comprehensive user permissions and entitlements system for sails.js and Waterline. Supports user authentication with passport.js, role-based permissioning, object ownership, and row-level security. 项目地址: https://gitcode.com/gh_mirrors/sa/sails-permissions