Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/saeven/zf3-circlical-user
Turnkey Authentication, Identity, and RBAC for Laminas and Zend Framework 3. Supports Doctrine and Middleware.
https://github.com/saeven/zf3-circlical-user
acl authentication laminas laminas-mvc rbac user
Last synced: about 2 months ago
JSON representation
Turnkey Authentication, Identity, and RBAC for Laminas and Zend Framework 3. Supports Doctrine and Middleware.
- Host: GitHub
- URL: https://github.com/saeven/zf3-circlical-user
- Owner: Saeven
- License: mpl-2.0
- Created: 2016-06-29T17:36:15.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-03-21T13:28:25.000Z (9 months ago)
- Last Synced: 2024-10-13T23:12:15.038Z (2 months ago)
- Topics: acl, authentication, laminas, laminas-mvc, rbac, user
- Language: PHP
- Homepage:
- Size: 444 KB
- Stars: 36
- Watchers: 7
- Forks: 15
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Authentication, Identity, and RBAC for the Laminas Framework
[](https://www.codacy.com/gh/Saeven/zf3-circlical-user/dashboard?utm_source=github.com&utm_medium=referral&utm_content=Saeven/zf3-circlical-user&utm_campaign=Badge_Grade)
[](https://www.codacy.com/gh/Saeven/zf3-circlical-user/dashboard?utm_source=github.com&utm_medium=referral&utm_content=Saeven/zf3-circlical-user&utm_campaign=Badge_Coverage)
[](https://packagist.org/packages/saeven/zf3-circlical-user)
[](https://packagist.org/packages/saeven/zf3-circlical-user)
[](https://sonarcloud.io/dashboard?id=Saeven_zf3-circlical-user)
[](https://gitter.im/Circlical/zf3-circlical-user?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
Plug and play authentication, roles, resource, and action control for Laminas.
Quickly Installs:
- cookie based authentication (using halite and its authenticated encryption)
- role-based access control (RBAC) with guards at the controller and action level
- user-based access control to complement RBAC
- resource-based permissions, giving you 'resource' and 'verb' control at the role and user level, e.g. (all administrators can 'add' a server, only Pete can 'delete')
You can see it in action, in this [ready-to-use skeleton](https://github.com/Saeven/laminas-mvc-skeleton).
### Missive
Sure - there are other Authentication, ACL, and User modules out there. This one comes with out-of-the-box support for **Doctrine** - just plug in your user entity and go.
Authentication is persisted using cookies, meaning no session usage at all. This was done because I develop for circumstances where this is preferable, removing any need for complex or error-prone solutions for session management on an EC2 auto-scale group for example.
Lastly, authenticated encryption is handled using the well-trusted [Halite](https://github.com/paragonie/halite), and password hashing is properly done with PHP's new password functions.
[Feedback always solicited on r/php.](https://www.reddit.com/r/PHP/comments/4r84jn/need_reviews_of_cookiebased_authentication_service/). If you are a paranoid fellow like me, this library should serve well!
This library works on a deny-first basis. Everything defined by its parts below, are 'allow' grants.
## User Authentication
The module provides full identity/auth management, starting at the user-level. A design goal was to connect this to registration or login processes with little more than one-liners.
#### Login
Validate your submitted Login form, and then execute this to get your user through the door:
$user = $this->auth()->authenticate( $emailOrUsername, $password );
Successful authentication, will drop cookies that satisfy subsequent identity retrieval.
#### Logout
Trash cookies and regenerate the session key for that user, using this command:
$this->auth()->clearIdentity();
## Pluggable Deny Strategy
Someone trying to do something they shouldn't? It's easy to control what happens with a pluggable DenyStrategy. Create a class that implements DenyStrategyInterface and plug it into your config. This module comes with a default **RedirectStrategy** that will send users to a login page, if the
problem was that there was no auth, and it wasn't an XHTTP request. Easy to use, you'd configure it like so:
'deny_strategy' => [
'class' => \CirclicalUser\Strategy\RedirectStrategy::class,
'options' => [
'controller' => \Application\Controller\LoginController::class,
'action' => 'index',
],
],
Writing your own should be very simple, see provided tests.
## Pluggable Password Strength Checker
You can use the built-in support for [paragonie/passwdqc](https://github.com/paragonie/passwdqc) by uncommenting the password_strength_checker config key. You can also roll your own if you have more complex needs; uncomment the key and specify your own implementation
of [PasswordCheckerInterface](src/CirclicalUser/Provider/PasswordCheckerInterface.php). This will cause the password input routines to throw WeakPasswordExceptions when weak input is received.
Configuration of the password checker can be done two ways:
#### Class without options
'password_strength_checker' => \CirclicalUser\Service\PasswordChecker\Passwdqc::class,
#### Class with options
'password_strength_checker' => [
'implementation' => \CirclicalUser\Service\PasswordChecker\Zxcvbn::class,
'config' => [
'required_strength' => 3,
],
],
## Creating Access For Your Users
Your app needs to be modified to create a distinct auth record for each user. It's very simple.
#### create & authenticate
During user registration routines, you probably want to create the records and also log them in. To accomplish this, you can use the helper or the 'create' method on AccessService.
From a Controller, you can use the auth plugin:
$this->auth()->create(User $user, string $usernameOrEmail, string $password); // controller helper
or, the AuthenticationService:
$container->get(AuthenticationService::class)->create($user, $usernameOrEmail, $password);
#### create only
Otherwise, if you simply want to create a user auth record but not log them in, use:
$container->get(AuthenticationService::class)->registerAuthenticationRecord(User $user, string $username, string $password)
## Roles
Your users belong to hierarchical roles that are configured in the database. *The default guest user, is group-less.*
Roles are used to restrict access to **controllers**, **actions**, or **resources**.
## Guards
Guards are conditions on **controllers** & **actions** -- or **middleware** -- that examine **group** or **user** privileges to permit/decline attempted access. It works very similarly to [BjyAuthorize](https://github.com/bjyoungblood/BjyAuthorize)
(a great module I used for years).
Configuring guards is very simple. Your module's config would look like so:
return [
'circlical' => [
'user' => [
'guards' => [
'ModuleName' => [
"controllers" => [
\Application\Controller\IndexController::class => [
'default' => [], // anyone can access
],
\Application\Controller\MemberController::class => [
'default' => ['user'], // specific role access
],
\Application\Controller\AdminController::class => [
'default' => ['admin'],
'actions' => [ // action-level guards
'list' => [ 'user' ], // role 'user' can access 'listAction' on AdminController
],
],
\Application\Controller\ComplexController::class => [
'default' => ['user'],
'actions' => [ // action-level guards
'save' => [
AccessService::GUARD_ACTION => 'save', // you can lean on action/resource rules as well
AccessService::GUARD_RESOURCE => 'complex', // which call 'isAllowed' on AccessService
],
'delete' => [
AccessService::GUARD_ROLE => 'admin', // it is also possible to override the role requirement
AccessService::GUARD_ACTION => 'save',
AccessService::GUARD_RESOURCE => 'complex',
],
],
],
],
],
],
],
],
];
If you are defining access for [middleware route definitions](https://docs.zendframework.com/zend-mvc/middleware/#mapping-routes-to-middleware), then you don't need to configure the 'actions' section above. Further, the Module is then ignored, so you can place your middleware handler's class in any
module; example:
return [
'circlical' => [
'user' => [
'guards' => [
'Middleware' => [
"controllers" => [
\Application\Middleware\MiddlewareHandler::class => [
'default' => [], // anyone can access
],
],
],
],
],
],
];
## Resources & Permissions
Resources can be:
* simple strings, or
* anything you have that implements [ResourceInterface](src/CirclicalUser/Provider/ResourceInterface.php)
Both these usages are valid from a controller:
$this->auth()->isAllowed('door','open');
or if an object:
// server implements ResourceInterface
$server = $serverMapper->get(142);
$this->auth()->isAllowed($server,'shutdown');
The AccessService is also similarly usable. See [AccessService tests](bundle/Spec/Service/AccessServiceSpec.php) for more usage examples.
Granting a **role** a **permission** is done through the AccessService
### User Permissions
You can also give individual users, access to specific actions on resources as well. This library provides
**Doctrine** entities and a mapper to make this happen -- but you could wire your own [UserPermissionProviderInterface](src/CirclicalUser/Provider/UserPermissionProviderInterface.php)
very easily. In short, this lets the AccessService use the authenticated user to determine whether or not the logged-in individual can perform an action that supersedes what his role permissions otherwise grant. User Permissions are meant to be more permissive, not restrictive.
### User API Tokens
This module also provides a utility with which to generate UserApiToken objects. See tests for usage.
Adding the mapping for this entity to your User entity is very trivial
/**
* @ORM\OneToMany(targetEntity="CirclicalUser\Entity\UserApiToken", mappedBy="user");
*/
private $api_tokens;
Pulling a token to perform your own logic with it, is done with UserApiTokenMapper, e.g.
$token = $this->userApiTokenMapper->get('d0cad39b-f269-405e-b3f9-d45b349c0587');
When it is used/consumed, you can tag it:
$token->tagUse();
Scope (as defined by your application) is defined with bit flags
$token->addScope(FooApi::SCOPE_QUERY);
# Cookie Security
You can configure whether or not your cookies should have the secure flag set to 'true' by adjusting the auth/secure_cookies configuration value. This value accepts a boolean or closure if you need to run a discovery method on your server, perhaps, for example, to check if the current request is
coming through SSL.
# Installation
* Working with Doctrine? [Click Here](INSTALL_DOCTRINE.md)
* Want to roll your own Providers? [Click Here](INSTALL_CUSTOM.md)
# Composer Tune-Ups
This package's dependency chain depends on `doctrine/doctrine-module`, which in turn depends on `laminas/laminas-cache`.
Laminas cache is wired in a strange way, and might attempt to install a ton of problematic adapters (depending on your PHP version). It is recommended that you use composer's replace to keep that mess out of your application, like so:
```
"replace": {
"laminas/laminas-cache-storage-adapter-apc": "*",
"laminas/laminas-cache-storage-adapter-apcu": "*",
"laminas/laminas-cache-storage-adapter-blackhole": "*",
"laminas/laminas-cache-storage-adapter-dba": "*",
"laminas/laminas-cache-storage-adapter-ext-mongodb": "*",
"laminas/laminas-cache-storage-adapter-filesystem": "*",
"laminas/laminas-cache-storage-adapter-memcache": "*",
"laminas/laminas-cache-storage-adapter-memcached": "*",
"laminas/laminas-cache-storage-adapter-mongodb": "*",
"laminas/laminas-cache-storage-adapter-redis": "*",
"laminas/laminas-cache-storage-adapter-session": "*",
"laminas/laminas-cache-storage-adapter-wincache": "*",
"laminas/laminas-cache-storage-adapter-xcache": "*",
"laminas/laminas-cache-storage-adapter-zend-server": "*",
},
```
What's more, since you are using this library, you probably aren't using `laminas/laminas-authentication`, which is also installed by doctrine-module. You can go ahead and throw this line into your replace block as well:
```
"laminas/laminas-authentication": "*",
```