Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ezralazuardy/heimdall
Painless OAuth 2.0 Server for CodeIgniter 4 🔥
https://github.com/ezralazuardy/heimdall
codeigniter4 composer heimdall oauth2-server restful
Last synced: 23 days ago
JSON representation
Painless OAuth 2.0 Server for CodeIgniter 4 🔥
- Host: GitHub
- URL: https://github.com/ezralazuardy/heimdall
- Owner: ezralazuardy
- License: mit
- Created: 2020-08-20T15:09:28.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2021-07-09T04:52:23.000Z (over 3 years ago)
- Last Synced: 2024-05-17T17:03:12.612Z (6 months ago)
- Topics: codeigniter4, composer, heimdall, oauth2-server, restful
- Language: PHP
- Homepage: https://heimdall.ezralazuardy.com
- Size: 242 KB
- Stars: 39
- Watchers: 7
- Forks: 9
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
## 🤺 heimdall
Inspired from the Norse mythology, [Heimdallr](https://en.wikipedia.org/wiki/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](https://heimdall.ezralazuardy.com/documentation/oidc) support to gives you a simple identity layer on top of the OAuth 2 protocol and a [Proof Key for Code Exchange](https://heimdall.ezralazuardy.com/documentation/pkce) support.
Heimdall implements the standards compliant implementation of an [OAuth 2](https://tools.ietf.org/html/rfc6749) 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](https://github.com/thephpleague/oauth2-server) library by [thephpleague](https://thephpleague.com/).
#### Latest version
See the latest version of Heimdall [here](https://github.com/ezralazuardy/heimdall/releases).
## ✍️ Installation
In order to install Heimdall, you have to use [Composer](https://getcomposer.org/).
In the root directory of your CodeIgniter 4 project, fire up a terminal and run:
```bash
composer require ezralazuardy/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](https://heimdall.lazuardy.tech).
## 📖️ Documentation
Read the Heimdall documentation on https://heimdall.lazuardy.tech.
## 👷️ Contributing
All contributions are welcomed. Please make a [pull request](https://github.com/ezralazuardy/heimdall/pulls) so that I can review your changes.
Before start making contributions to Heimdall, please read the [contribution guidelines](https://github.com/ezralazuardy/heimdall/blob/master/CONTRIBUTING.md) and [code of conduct](https://github.com/ezralazuardy/heimdall/blob/master/CODE_OF_CONDUCT.md).
## 🛡️ Security Policy
Read the current Heimdall's security policy [here](https://github.com/ezralazuardy/heimdall/security/policy).
## 🗒️ Side Note
Heimdall is at it's early stage. If you experiencing an error or bug, please report by creating a new [issues](https://github.com/ezralazuardy/heimdall/issues).
## 📜 License
