CodeIgniter Shield 开源项目教程

CodeIgniter Shield 开源项目教程

shield Authentication and Authorization for CodeIgniter 4 项目地址: https://gitcode.com/gh_mirrors/shi/shield

1. 项目介绍

CodeIgniter Shield 是一个基于 CodeIgniter 4 框架的身份验证和授权库。它旨在为开发者提供一个简单、灵活且安全的身份验证解决方案。Shield 提供了多种身份验证方法，包括传统的基于表单的登录、基于令牌的认证（如 JWT）、以及 OAuth 2.0 支持。此外，Shield 还提供了强大的授权功能，允许开发者定义细粒度的权限控制。

2. 项目快速启动

安装

首先，确保你已经安装了 Composer。然后，通过以下命令安装 CodeIgniter Shield：

composer require codeigniter4/shield

配置

在 app/Config/Auth.php 文件中配置 Shield 的设置。以下是一个简单的配置示例：

use CodeIgniter\Shield\Config\Auth;

$config = new Auth();
$config->authenticators = ['session', 'tokens'];
$config->allowRegistration = true;
$config->allowRemembering = true;
$config->rememberLength = 30 * DAY;

return $config;

创建用户

使用以下代码创建一个新用户：

use CodeIgniter\Shield\Entities\User;
use CodeIgniter\Shield\Models\UserModel;

$user = new User([
    'username' => 'johndoe',
    'email'    => 'johndoe@example.com',
    'password' => 'secret',
]);

$userModel = new UserModel();
$userModel->save($user);

用户登录

使用以下代码进行用户登录：

use CodeIgniter\Shield\Authentication\Authenticators\Session;

$authenticator = new Session();
$authenticator->attempt([
    'email'    => 'johndoe@example.com',
    'password' => 'secret',
]);

3. 应用案例和最佳实践

案例1：多因素认证

CodeIgniter Shield 支持多因素认证（MFA），可以通过配置启用。以下是一个启用 MFA 的示例：

$config->allowMultiFactor = true;
$config->multiFactorMethods = ['email', 'totp'];

最佳实践：权限控制

使用 Shield 的授权功能来定义细粒度的权限控制。例如，你可以为不同的用户角色定义不同的权限：

use CodeIgniter\Shield\Authorization\Authorization;

$authorization = new Authorization();
$authorization->addPermission('admin', 'manageUsers');
$authorization->addPermission('editor', 'editPosts');

4. 典型生态项目

CodeIgniter 4

CodeIgniter 4 是一个轻量级、快速且功能强大的 PHP 框架，适用于构建各种 Web 应用程序。Shield 作为 CodeIgniter 4 的官方身份验证库，与框架紧密集成，提供了无缝的身份验证和授权体验。

Shield 扩展

Shield 还支持多种扩展，如 OAuth 2.0 提供者扩展、JWT 扩展等。这些扩展可以进一步增强 Shield 的功能，满足不同应用场景的需求。

通过以上步骤，你可以快速上手并使用 CodeIgniter Shield 构建安全的身份验证和授权系统。

shield Authentication and Authorization for CodeIgniter 4 项目地址: https://gitcode.com/gh_mirrors/shi/shield