README

This is a fork of https://github.com/ezralazuardy/heimdall. That repo appears to have gone dead, and has some compatibility issues with php 8.1, so I'm trying to keep it current here.

I'll minimally try to keep this current with the latest PHP version, but as I have time, I'll be working on the following:

Get the docs site up and running again
Publish example DB migrations for Token/Client/Scope/etc. repositories that the core oauth2 server requires
Controller examples for /token, /authorize, etc.
There are dependencies from the Slim framework that were copied over, I'd like to replace them with equivalent classes that already exist in CI4.
Maybe some improvements to make it easier to grab more detailed info about an authenticated user & token

Inspired from the Norse mythology, Heimdallr, modernly anglicized as Heimdall is the gatekeeper of Bifröst, the rainbow road connecting Midgard, realm of the humans, to Asgard, the realm of Gods.

In CodeIgniter 4, Heimdall serves as the gatekeeper between the client and resource server. Heimdall gives you an out of the box OAuth 2 authorization protocol implementation to your CodeIgniter's Web Service. Heimdall also comes with some handy extensions such as Open ID Connect support to gives you a simple identity layer on top of the OAuth 2 protocol and a Proof Key for Code Exchange support.

Heimdall implements the standards compliant implementation of an OAuth 2 authorization server written in PHP which makes working with OAuth 2 trivial. You can easily configure an OAuth 2 server to protect your API with access tokens, or allow clients to request new access tokens and refresh them.

This library was created in order to simplify the need of OAuth 2 implementation in your CodeIgniter 4 framework, based on the OAuth 2.0 Server library by thephpleague.

Latest version

See the latest version of Heimdall here.

✍️ Installation

In order to install Heimdall, you have to use Composer.

In the root directory of your CodeIgniter 4 project, fire up a terminal and run:

composer require mv-steven/heimdall

Heimdall is now ready to be configured and run in your server.

🚀️ Getting Started

In order to start configuring & implementing Heimdall in your CodeIgniter 4 project, please refer to the documentation.

📖️ Documentation

Read the Heimdall documentation here.

👷️ Contributing

All contributions are welcomed. Please make a pull request so that I can review your changes.

Before start making contributions to Heimdall, please read the contribution guidelines and code of conduct.

🛡️ Security Policy

Read the current Heimdall's security policy here.

🗒️ Side Note

Heimdall is at it's early stage. If you experiencing an error or bug, please report by creating a new issues.

mv-steven / heimdall

Maintainers

Details