Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dereuromark/cakephp-tinyauth
CakePHP TinyAuth plugin for an easy and fast user authentication and authorization. Single or multi role. DB or config file based.
https://github.com/dereuromark/cakephp-tinyauth
acl authentication authorization cakephp cakephp-plugin multi-role php
Last synced: 9 days ago
JSON representation
CakePHP TinyAuth plugin for an easy and fast user authentication and authorization. Single or multi role. DB or config file based.
- Host: GitHub
- URL: https://github.com/dereuromark/cakephp-tinyauth
- Owner: dereuromark
- License: mit
- Created: 2014-09-18T13:56:34.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2024-09-24T09:28:33.000Z (about 2 months ago)
- Last Synced: 2024-10-11T06:32:35.732Z (29 days ago)
- Topics: acl, authentication, authorization, cakephp, cakephp-plugin, multi-role, php
- Language: PHP
- Homepage:
- Size: 4.3 MB
- Stars: 126
- Watchers: 10
- Forks: 43
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-cakephp - TinyAuth plugin - Authentication and role-based (single/multi) authorization as very light-weight approach. (Authentication and Authorization)
README
# CakePHP TinyAuth Plugin
[](https://github.com/dereuromark/cakephp-tinyauth/actions/workflows/ci.yml?query=branch%3Amaster)
[](https://packagist.org/packages/dereuromark/cakephp-tinyauth)
[](https://codecov.io/github/dereuromark/cakephp-tinyauth/branch/master)
[](https://php.net/)
[](LICENSE)
[](https://packagist.org/packages/dereuromark/cakephp-tinyauth)
[](https://github.com/php-fig-rectified/fig-rectified-standards)
A CakePHP plugin to handle authentication and user authorization the easy way.
This branch is for **CakePHP 5.0+**. For details see [version map](https://github.com/dereuromark/cakephp-tinyauth/wiki#cakephp-version-map).
## Features
### Authentication
What are public actions, which ones need login?
- Powerful wildcard (*) operator.
- [Quick Setup](https://github.com/dereuromark/cakephp-tinyauth/blob/master/docs/Authentication.md#quick-setups) for 5 minute integration.
### Authorization
Once you are logged in, what actions can you see with your role(s)?
- Single-role: 1 user has 1 role (users and roles table for example)
- Multi-role: 1 user can have 1...n roles (users, roles and a "roles_users" pivot table for example)
- [Quick Setup](https://github.com/dereuromark/cakephp-tinyauth/blob/master/docs/Authorization.md#quick-setups) for 5 minute integration.
### Useful helpers
- AuthUser Component and Helper for stateful and stateless "auth data" access.
- Authentication Component and Helper for `isPublic()` check on current other other actions.
- Auth DebugKit panel for detailed insights into current URL and auth status.
## What's the idea?
Default CakePHP authentication and authorization depends on code changes in at least each controller, maybe more classes.
This plugin hooks in with a single line of change and manages all that using config files and there is no need to touch all those controllers, including plugin controllers.
It is also possible to manage the config files without the need to code.
And it can with adapters also be moved completely to the DB and managed by CRUD backend.
Ask yourself: Do you need the overhead and complexity involved with the full blown (RBAC DB) ACL? See also my post [acl-access-control-lists-revised/](https://www.dereuromark.de/2015/01/06/acl-access-control-lists-revised/).
If not, then this plugin could very well be your answer and a super quick solution to your auth problem :)
But even if you don't leverage the authentication or authorization, the available AuthUserComponent and AuthUserHelper
can be very useful when dealing with role based decisions in your controller or view level. They also work stand-alone.
## Demo
See https://sandbox.dereuromark.de/auth-sandbox
### auth_allow.ini
Define the public actions (accessible by anyone) per controller:
```ini
Users = index,view
Admin/Maintenance = pingCheck
PluginName.SomeController = *
MyPlugin.Api/V1 = *
```
### auth_acl.ini
Define what actions may be accessed by what logged-in user role:
```ini
[Users]
index = *
add,edit = user,super-user
[Admin/Users]
* = admin
[Translate.Admin/Languages]
* = *
```
### AuthUser component and helper
```php
$currentId = $this->AuthUser->id();
$isMe = $this->AuthUser->isMe($userEntity->id);
if ($this->AuthUser->hasRole('mod')) {
}
if ($this->AuthUser->hasAccess(['action' => 'secretArea'])) {
}
// Helper only
echo $this->AuthUser->link('Admin Backend', ['prefix' => 'Admin', 'action' => 'index']);
echo $this->AuthUser->postLink('Delete', ['action' => 'delete', $id], ['confirm' => 'Sure?']);
```
## Installation
Including the plugin is pretty much as with every other CakePHP plugin:
```bash
composer require dereuromark/cakephp-tinyauth
```
Then, to load the plugin either run the following command:
```sh
bin/cake plugin load TinyAuth
```
or manually add the following line to your app's `src/Application.php` file's `bootstrap()` function:
```php
$this->addPlugin('TinyAuth');
```
That's it. It should be up and running.
## Docs
For setup and usage see [Docs](/docs).
Also note the original [blog post](https://www.dereuromark.de/2011/12/18/tinyauth-the-fastest-and-easiest-authorization-for-cake2/) and how it all started.