auth.md

layout	title	order	repo
page	Auth	7	auth

Authorization module that supports multiple auth methods (storages)

• Install
  • Configure your app
  • Add new provider and middleware
  • Add rbac to your routes
• Usage
  • Auth
  • Examples

Install

composer require wtf/auth
# for JWT
composer require wtf/rest
# for Cookie
composer require dflydev/fig-cookies
# for LDAP provider
composer require symfony/ldap:^4

# for Session you should install PHP session module

Configure your app

Create config file app/config/auth.php:

<?php

declare(strict_types=1);

return [
    'entity' => 'user', // user entity
    'storage' => \Wtf\Auth\Storage\Session::class, // can be Session, Cookie, JWT
    'repository' => \Wtf\Auth\Repository\User::class, // default user repository, available: LDAP
    'rbac' => [
        'defaultRole' => 'anonymous' //default unauthorized role
    ],
    'ldap' => [ //ONLY for ldap
        'server' => [
            'host' => 'ldap.server',
            'port' => 389,
            'encryption' => 'none',
            'options' => [
                'protocol_version' => 3,
                'referrals' => true,
            ],
        ],
        'admin' => [
            'dn' => 'cn=admin,dc=framework,dc=wtf',
            'password' => 'supersecret',
        ],
        'baseDN' => 'cn=Users,dc=framework,dc=wtf',
        'fields' => [
            'login' => ['uid', 'mail'], //login fields in LDAP direcotry
            'loginInDb' => 'email', //login field in DB, for on-the-fly user creation
            'map' => [ //fields map, <ldap field> => <db field>, for on the fly user creation
                'cn' => 'name',
            ],
        ],
    ],
];

Add new provider and middleware

1. \Wtf\Auth\Provider into your providers list (app/config/suit.php config)
2. rbac_middleware into your middlewares list (app/config/suit.php config)

Add rbac to your routes

Example route group home (from skeleton):

<?php

return [
    // ...
    'second' => [
        'pattern' => '/second', //route pattern, match: /home/second
        'methods' => ['GET', 'POST', 'PATCH'], //Allowed HTTP methods
        'rbac' => [
            'anonymous' => ['GET'], // allow unauthorized users (role: anonymous) to GET /home/second
            'user' => ['GET', 'POST'], // allow authorized users (role: user) to GET and POST /home/second
            'admin' => ['GET', 'POST', 'PATCH'] //allow admins (role: admin) to GET, POST and PATCH /home/second
        ],
    ],
];

Usage

Auth

Each auth type uses following methods:

public function login(string $login, string $password)

Result of login() different for each auth type:

• Cookie: will return cookie object, you should set it to response: $response = \Dflydev\FigCookies\FigResponseCookies::set($response, $cookie);
• JWT: will return jwt token string, you can return in in response: $response->withJson(['token' => $token]);
• Session: will return user entity object

public function isLoggedIn(): bool

public function getUser(): ?Root

public function logout(): void

public function forgot(string $login): string

public function reset(string $code, string $new_password): bool

Examples

$this->auth available from any child of \Wtf\Root class

Login:

$this->auth->login('[email protected]', 'password');

Get user:

//without login user will be null, so let's login first
if(!$this->auth->isLoggedIn()) {
    $this->auth->login('[email protected]', 'password');
}
$this->auth->getUser();
//or simple
$this->user;

Logout;

$this->auth->logout();

Forgot / reset password:

// User sends login (email, etc.)
$login = 'user_who_forgot_password';

// forgot() will find user by login and set special one-time code to allow password reset
$code = $this->auth->forgot($login);

// ...
// you send email to user with that $code
// user clicks on link with $code from email you sent him
// you shows user page, where he can set new password,
// after that you calls following function
$isPasswordReset = $this->auth->reset($code, $new_password);

//$isPasswordReset will be (bool) true if password was changed successful