poweronsystem/authorizationservice

Servicio de autorizacion de usuarios y sectores.

PowerOn System - AuthorizationService

Servicio de autorización de usuarios, inicio, cierre, pausa y resumen de sesión., _(*1)

Instalación vía Composer

Podés instalar AuthorizationService vía Composer a través de la consola:, _(*2)

``` bash $ composer require poweronsystem/authorizationservice, <sub>(*3)</sub>

## Requisitos

* PHP >= 5.4
* poweronsystem/utility: "^0.1.3"

## Uso

### Instancia y configuración
Creación de la clase y configuración básica de la misma

``` php
//Autoload composer
require '/vendor/autoload.php';

//Configuración del autenticador (Ver archivo src/Authorization.php)
$config =  [
  'login_session_time' => 7200,
  'login_session_inactive_time' => 3600
];

//Establecemos los permisos para los sectores
$permissions = [];

//Creamos una instancia del autorizador
$auth = new PowerOn\Authorization\Authorization($config, $permissions);

Ejemplo de autenticación de usuarios

Adaptador de sesiones

Adaptador de ejemplo ``` php, <sub>(*4)</sub>

namespace App;, <sub>(*5)</sub>

use PowerOn\Database\Model; use PowerOn\Authorization\AuthorizationAdapterInterface; use PowerOn\Authorization\UserCredentials;, <sub>(*6)</sub>

public class MyAdapter implements AuthorizationAdapterInterface { private $db;, <sub>(*7)</sub>

public function __construct($database) {
    $this->db = $database;
}

public function login(UserCredentials $credentials) {
    /* Lógica de comprobación de usuario ...
     * Lógica de Password Hasher personalizada ...
     * $user = $db->getUser($credentials->username, $credentials->password);
     * ...
     */

    //Si es inválido retorna FALSE

    //Si es correcto devuelve las credenciales con los datos del usuario que se deseen cargar
    $credentials->setUserData($user);

    //Se establece el nivel de acceso del usuario
    $credentials->setUserAccessLevel($user['access_level']);

    //Otra lógica adicional antes de finalizar...

    return $credentials;
}

public function logout() {
    return TRUE;
}

public function pauseSession() {
    return TRUE;
}

public function resumeSession() {
    return TRUE;
}

}, <sub>(*8)</sub>

Registrar adaptador a la clase

``` php
//Base de datos requerida por el adaptador de ejemplo
$database = new PDO();

//Instancia del adaptador
$adapter = new App\MyAdapter($database);

//Registro del adaptador
$auth->registerAdapter($adapter);

Inicio de sesión

``` php //Credenciales obtenidas de un formulario $credentals = new PowerOn\Authorization\UserCredentials($_POST['username'], $_POST['password']); try { $auth->login($login_credentials); //Login success, <sub>(*9)</sub>

echo $auth->getStatus(); //ok, <sub>(*10)</sub>

} catch (PowerOn\Authorization\AuthorizationException $e) { //Lógica de excepciones, <sub>(*11)</sub>

echo $auth->getStatus(); //user_not_found | user_error }, <sub>(*12)</sub>

#### Cierre de sesión

``` php
$auth->logout();

echo $auth->getStatus(); //user_not_found

Pausa

``` php $auth->pause();, <sub>(*13)</sub>

echo $auth->getStatus(); //paused var_dump($auth->isValid()); //bool(false), <sub>(*14)</sub>

#### Resumen

``` php
$auth->resume();

echo $auth->getStatus(); //ok
echo $auth->getUserCredentials->getSessionInactiveTime(); //120
var_dump($auth->isValid()); //bool(true)

Ejemplo de authorización de sectores

Ejemplo básico para la validación de sectores, <sub>(*15)</sub>

Configuración de permisos

``` php //Establecemos los permisos para los sectores de la siguiente manera $permissions = [ //La url "/home" require un nivel de acceso básico de 1 '/home' => ['access_level' => 1],, <sub>(*16)</sub>

//Cualquier sector referente a "/admin" requerirá un nivel de acceso de 10 o superior '/admin/*' => ['access_level' => 10],, <sub>(*17)</sub>

//En este ejemplo solo permitimos el acceso a "/account/new-password" para que el usuario cambie su contraseña //solo en caso que haya transcurrido más de un dia desde la última modificación. '/account/new-password => ['allowed' => function(\PowerOn\Authorization\UserCredentials $userCredentials) { return (time() - $userCredentials['last_password_request_time']) > 86400; }] ];, <sub>(*18)</sub>

//Creamos una instancia del autorizador $auth = new PowerOn\Authorization\Authorization($config, $permissions);, <sub>(*19)</sub>

#### Ejecución de validación de permisos de sectores

``` php
//Clase Request genérica de ejemplo
$request = new \App\MyRequestClass();

//Url obtenida de una clase request
$url = $request->getUrl();

//Otros archivos adicionales a pasar en la función callable del array de permisos con la clave "allowed"
$otherFile = new \App\SomeClass();

$result = $auth->sector($url, $request, $otherFile);

var_dump($result); //bool(false) | bool(true)
echo $auth->getStatus(); //sector_low_access_level | sector_not_allowed