Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/germaniakg/authorization
Simple authorization solution with no hierarchical stuff so far.
https://github.com/germaniakg/authorization
acl auth authorization callable container-interop middleware psr-11 psr-7
Last synced: 20 days ago
JSON representation
Simple authorization solution with no hierarchical stuff so far.
- Host: GitHub
- URL: https://github.com/germaniakg/authorization
- Owner: GermaniaKG
- License: mit
- Created: 2016-11-01T08:33:57.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-09T14:05:43.000Z (almost 2 years ago)
- Last Synced: 2024-04-10T05:06:44.839Z (9 months ago)
- Topics: acl, auth, authorization, callable, container-interop, middleware, psr-11, psr-7
- Language: PHP
- Size: 113 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Germania KG · Authorization
**Simple authorization solution with [PSR-11 Container](https://github.com/php-fig/container) compatibility and PSR-7 style Middleware. No hierarchical stuff so far.**
[](https://packagist.org/packages/germania-kg/authorization)
[](https://packagist.org/packages/germania-kg/authorization)
[](https://github.com/GermaniaKG/Authorization/actions/workflows/tests.yml)
## Installation
```bash
$ composer require germania-kg/authorization
```
## Setup
The *Authorization* constructor requires an Access Control List, i.e. an array with *tasks* as keys and *allowed roles arrays* as elements. The second parameter defines whether to permit in case a task is not defined.
```php
[ "coworkers", "superuser"],
'/bar' => [ "superuser", "registered"]
);
// Wether to permit undefined tasks
$default_permission = true;
// Create instance, optional with PSR-3 Logger
$authorization = new Authorization( $acl, $default_permission );
$authorization = new Authorization( $acl, $default_permission, $logger );
```
## Usage
The *Authorization* class implements the *AuthorizationInterface* which defines a single *authorize* method. Additionally, *Authorization* provides a *__invoke* function und thus is callable.
```php
authorize("/foo", $user_roles);
$allowed = $authorization("/foo", $user_roles);
// Result is FALSE
$allowed = $authorization->authorize("/bar", $user_roles);
$allowed = $authorization("/bar", $user_roles);
// Should be TRUE due to default permission above
$allowed = $authorization->authorize("/somethingelse", $user_roles);
$allowed = $authorization("/somethingelse", $user_roles);
```
**Per-task logging:** Both *authorize* and *__invoke* Methods do accept an optional PSR-3 Logger instance. This enables you to disable or override the default logger you passed on instantiation. Example:
```php
authorize("/foo", $user_roles, $silent_log);
$authorization("/foo", $user_roles, $silent_log);
```
## Container Interoperability
The *AuthorizationInterface* implements both [PSR-11 ContainerInterface](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-11-container.md) and the deprecated *[Interop\Container\ContainerInterface](https://github.com/container-interop/container-interop/blob/master/docs/ContainerInterface.md)* for backward compatibility.
So you can test if your *Authorization* instance *has* a task and *get* the allowed roles.
If a task is not defined, a *TaskNotFoundException* exception will be thrown. This class implements both the *[Interop\Container\Exception\NotFoundException](https://github.com/container-interop/container-interop/blob/master/docs/ContainerInterface.md#4-interopcontainerexceptioncontainerexception)* and PSR-11's [Psr\Container\NotFoundExceptionInterface](https://github.com/php-fig/container/blob/master/src/NotFoundExceptionInterface.php) interface.
More information: [PSR-11 Container](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-11-container.md) • [container-interop/container-interop](https://github.com/container-interop/container-interop)
```php
has( "/foo" );
// array( "coworkers", "superuser"] )
try {
$roles = $authorization->get( "/foo" );
// will throw TaskNotFoundException
$roles = $authorization->get( "/something-else" );
}
catch (NotFoundExceptionInterface $e) {
if ($e instanceOf NotFoundException) {
echo "Interop Container: NotFoundException";
}
}
```
## PSR 7-style Middleware
This packages offers three PSR7-style middlewares. All take a *Callable* authorizer (e.g. class Authorization, see above) and optionally a PSR-3 Logger.
If authorization fails, the Response object gets a `401 Unauthorized` status; after that, the next middelware will be called. This enables you to work with unauthorized requests in later middlewares or controllers.—Well, this is what basically happens inside:
```php
// Your Callable passed into constructor
$authorize = $this->authorizer;
if (!$authorize( $url )):
$response = $response->withStatus( 401 );
endif;
$response = $next($request, $response);
return $response;
```
### Request URI Authorization
**RequestUriAuthorizationMiddleware** will check [PSR-7 Request's](http://www.php-fig.org/psr/psr-7/#3-2-psr-http-message-requestinterface) URI string; suitable in most cases.
```php
[
// Set this to true to get access to route within middleware
'determineRouteBeforeAppMiddleware' => true
]
]);
// Add Middleware
$app->add( $middleware );
```
### Customizable Authorization
**AuthorizationMiddleware** is the base class of the two above, and more configurable. It takes *another Callable* returning a custom term (or “permission”, you name it) you like to authorize, next to our Authorization *Callable* from the examples above.
```php
getUri();
};
// Optionally with PSR-3 Logger
$middleware = new AuthorizationMiddleware( $auth, $url_getter );
$middleware = new AuthorizationMiddleware( $auth, $url_getter, $logger );
```
## Issues
See [issues list.][i0]
[i0]: https://github.com/GermaniaKG/Authorization/issues
## Development
```bash
$ git clone https://github.com/GermaniaKG/Authorization.git
$ cd Authorization
$ composer install
```
## Unit tests
Either copy `phpunit.xml.dist` to `phpunit.xml` and adapt to your needs, or leave as is. Run [PhpUnit](https://phpunit.de/) test or composer scripts like this:
```bash
$ composer test
# or
$ vendor/bin/phpunit
```