ssa/secure

Ssa secure module for ssa framework.

SSA Secure

Ssa secure is an extention of SSA[https://github.com/deblockt/ssa]., _(*1)

This provide a service for manager login., _(*2)

Installation

you need to add :, _(*3)

``` json "ssa/secure": "dev-master", <sub>(*4)</sub>

on your composer dependencies.

## Configuration

For use this module you need add service on your serviceManager.

*config.php*
``` php
ServiceManager::getInstance()->registerAllServices(array(
    'authenticateService' => array('class' => 'ssa\secure\services\AuthenticateService')
));

On this exemple the service name is authenticateService, but you can choose an other service name., <sub>(*5)</sub>

After you must configure the module :, <sub>(*6)</sub>

• Add security provider : Class used for logon users
• Change tokenCryptKey : This is the key used to encrypt user id. Change default token key for better security.

config.php ``` php use ssa\secure\SecureConfiguration;, <sub>(*7)</sub>

// SecurityProvider is your own class who implement ISecurityProvider SecureConfiguration::getInstance()->setSecurityProvider(new SecurityProvider()); SecureConfiguration::getInstance()->setTokenCryptKey('yourCryptKey');, <sub>(*8)</sub>

*SecurityProvider.php*
``` php
<?php

use ssa\secure\ISecurityProvider;
use ssa\secure\SecureConfiguration;

/**
 * class used for login users
 */
class SecurityProvider implements ISecurityProvider {

    /**
     * method used to authenticate user
     *
     * @param string $login the connection login
     * @param string $mdp the connection password
     *
     * @return the userd id. It is is used for generate unique token for this user. null is user not exists.
     *         or array if you need get specifique data on javascript, array need have a id key (it'is a unique if for identifiate user)
     */
    public function authenticate($login, $password) {
        // here just check the user passord
        // surely that you need to do an database access
        if ($password == 'admin') {
            return array('id' => $login, 'name' => $login);
        }
        return null; // user is not recognized
    }

}

Usage

Javascript

You need to add authenticate service on your page :, <sub>(*9)</sub>

``` html , <sub>(*10)</sub>

To login user, you just need to do :

``` js
authenticateService.login('username', 'password');

To logout user, you just need to do :, <sub>(*11)</sub>

``` js authenticateService.logout();, <sub>(*12)</sub>

To get your authenticate info (if your authenticate method return an array) :

``` js
authenticateService.getUserInfos()();

Javascript secure listener

Three listeners are available :, <sub>(*13)</sub>

• DisconnectListener : Listener called when a service return an error
• ConnectedListener : Listener called when the login is succefully do
• BadUserOrPasswordListener : Listener called when the login is badly do. Bad username or password

``` js authenticateService.addDisconnectListener(function(){ $('span.result').html('You are not logged'); });, <sub>(*14)</sub>

// token is the crypted user id // userInfos is array return by the authenticate method. The is index is not available on client side. authenticateService.addConnectedListener(function(token, userInfos){ $('span.result').html('You are logged, you can call service.'); });, <sub>(*15)</sub>

authenticateService.addBadUserOrPasswordListener(function(){ $('span.result').html('Bad loggin or password'); });, <sub>(*16)</sub>

### php

If you want secure a service (the user need to be logged to call service), just add @Secure annotation on your service method.

``` php 

use ssa\secure\annotations\Secure;

/**
 * @author thomas
 */
class HelloWorld {

    /**
     * @Secure
     *
     * @param string $userId the userId is automatically add by secure module. It's the id returned by authenticate method 
     * @return string 
     */
    public function helloYou($userId) {
        return 'hello ' .$userId.'!!!';
    }
}

All Secure service can need userId parameter, this is automatically add by secure module. Warning : this parameter must be the last parameter or nexts parameters must have default value., <sub>(*17)</sub>