mv-steven/heimdall

为 CodeIgniter 4 提供无痛苦 OAuth 2.0 服务器

资助包维护!
Patreon
Ko Fi

v1.0.0 2023-05-31 14:29 UTC

This package is not auto-updated.

Last update: 2024-09-19 18:38:48 UTC


README

这是一个对 https://github.com/ezralazuardy/heimdall 的分支。该仓库似乎已经废弃,并且与 php 8.1 存在一些兼容性问题,因此我在这里尝试保持其最新状态。

我会尽量保持与最新 PHP 版本的同步,但如果有时间,我将继续以下工作

  • 恢复文档站点
  • 发布核心 OAuth 2 服务器所需的 Token/Client/Scope 等. 仓库的示例数据库迁移
  • /token、/authorize 等. 的控制器示例
  • 有一些来自 Slim 框架的依赖项被复制过来,我想用 CI4 中已存在的等效类替换它们。
  • 也许可以通过一些改进来更轻松地获取有关认证用户和令牌的详细信息

Code Quality Maintainability Build Codacy Security Scan Releases Minimum PHP version Issues License

灵感来自北欧神话中的海姆达尔(Heimdallr),在现代英语中通常被拼作 Heimdall,是连接人类居住的米德加德(Midgard)和神域阿斯加德(Asgard)的彩虹桥比弗罗斯特(Bifröst)的守门人。

CodeIgniter 4 中,海姆达尔作为客户端和资源服务器之间的守门人。海姆达尔为您的 CodeIgniter 的 Web 服务提供了开箱即用的 OAuth 2 授权协议实现。海姆达尔还附带了一些实用的扩展,例如 Open ID Connect 支持,为您在 OAuth 2 协议之上提供了一个简单的身份层,以及 Proof Key for Code Exchange 支持。

海姆达尔实现了符合标准的 PHP 编写的 OAuth 2 授权服务器实现,这使得使用 OAuth 2 变得非常简单。您可以轻松配置 OAuth 2 服务器来保护您的 API,或允许客户端请求新的访问令牌并刷新它们。

创建这个库是为了简化在您的 CodeIgniter 4 框架中实现 OAuth 2 的需求,基于 OAuth 2.0 Server 库,该库由 thephpleague 提供。

最新版本

在此处查看 Heimdall 的最新版本 这里


✍️ 安装

为了安装 Heimdall,您必须使用 Composer

在您的 CodeIgniter 4 项目的根目录中,打开终端并运行

composer require mv-steven/heimdall

现在 Heimdall 已准备好在您的服务器中进行配置和运行。


🚀️ 入门

为了开始在您的 CodeIgniter 4 项目中配置和实现 Heimdall,请参阅 文档


📖️ 文档

在此处阅读 Heimdall 文档 这里


👷️ 贡献

欢迎所有贡献。请发起一个 pull request,以便我可以审查您的更改。

在开始为Heimdall贡献之前,请阅读贡献指南行为准则


🛡️ 安全策略

在此阅读当前Heimdall的安全策略。


🗒️ 侧记

Heimdall处于早期阶段。如果您遇到错误或虫虫,请通过创建新的问题来报告。


📜 许可证