Authentication

Introduction

Building user system in Windwalker is very easy, Windwalker includes a simple Authentication package to handle user auth.

Default User Package

In Windwalker Starter, there is an User package in src/Windwalker/User and has been registered to system. You can directly modify it to what you needed.

Before using it, you may run this command to import default user package schema:

php windwlaker migration migrate -p=wwuser

Get User

use Windwalker\Core\Authentication\User;

// Get current logged-in user
$user = User::get();

// Get a user by id
$user = User::get(12);

// Get user by conditions
$user = User::get(array('username' => 'christina'));

Login User

// Prepare user data
$credential = new Credential;
$credential->username = 'richael2123';
$credential->password = '12345678';

$bool = User::login($credential);

Remember me:

$bool = User::login($credential, true);

Logout User

$bool = User::logout();

Save User

use Windwalker\Crypt\Password;

$user->username = 'riaok3784';
$user->password = 'abc1234';

// Hash password
$password = new Password;

$user->password = $password->create($user->password);

User::save($user);

Delete User

// Delete by id
User::delete(12);

// Delete by conditions
User::delete(array('username' => 'richael3784'));

Create Your Own User Handler

Windwalker Built-in Authentication system can register a custom user handler, this user handler should implement the UserHandlerInterface:

use Windwalker\Core\Authentication\UserDataInterface;
use Windwalker\Core\Authentication\UserHandlerInterface;

class MyUserHandler implements UserHandlerInterface
{
    /**
     * load
     *
     * @param array $conditions
     *
     * @return  mixed|false
     */
    public function load($conditions) {}

    /**
     * save
     *
     * @param UserDataInterface $user
     *
     * @return  UserDataInterface
     */
    public function save(UserDataInterface $user) {}

    /**
     * delete
     *
     * @param UserDataInterface $user
     *
     * @return  boolean
     */
    public function delete(UserDataInterface $user) {}

    /**
     * login
     *
     * @param UserDataInterface $user
     *
     * @return  boolean
     */
    public function login(UserDataInterface $user) {}

    /**
     * logout
     *
     * @param UserDataInterface $user
     *
     * @return bool
     */
    public function logout(UserDataInterface $user) {}
}

See: Default UserHandler to learn how to write your use handler.

Then you may register it before application execute:

use Windwalker\Core\Authentication\User;

User::setHandler(new MyUserHandler);

Create Authentication Method

Windwalker Authentication allow developers attach multiple methods to match user(See Document).

This image described how authentication methods working.

Example Method to Find User From Database

use Windwalker\Authentication\Authentication;
use Windwalker\Authentication\Credential;
use Windwalker\Authentication\Method\AbstractMethod;
use Windwalker\Crypt\Password;
use Windwalker\DataMapper\DataMapper;

class DatabaseMethod extends AbstractMethod
{
    public function authenticate(Credential $credential)
    {
        // Not allow empty password
        if (!$credential->username || !$credential->password)
        {
            $this->status = Authentication::EMPTY_CREDENTIAL;

            return false;
        }

        $datamapper = new DataMapper('users');

        // Use user data to find user
        $user = $datamapper->findOne(array('username' => $credential->username));

        // User not found
        if ($user->isNull())
        {
            $this->status = Authentication::USER_NOT_FOUND;

            return false;
        }

        // User found, start to verify password
        $password = new Password;

        if (!$password->verify($credential->password, $user->password))
        {
            $this->status = Authentication::INVALID_CREDENTIAL;

            return false;
        }

        // Password verify success, return user data.
        $credential->bind($user);

        $this->status = Authentication::SUCCESS;

        return true;
    }
}

Then we must register this method before Application executed:

$auth = \Windwalker\Ioc::getAuthentication();
$auth->addMethod('database', new DatabaseMethod);

// OR

User::addMethod('database', new DatabaseMethod);

If you found a typo or error, please help us improve this document.