Documentation and tests are coming.
composer require spiral/auth
spiral register spiral/auth
To enable authorization service in your application foollowing steps are reuquired.
Mount Spiral\Auth\AuthBootloader to your application.
protected $load = [
//Can speed up class loading a little.
\Spiral\Core\Loader::class,
//...
\Spiral\Auth\Bootloaders\AuthBootloader::class,
//...
//Application specific bindings and bootloading
\Bootloaders\AppBootloader::class,
];You can either add middleware to a specific route or enable authroization services across application via http config:
'middlewares' => [
Middlewares\CsrfFilter::class,
Middlewares\ExceptionWrapper::class,
//Auth
\Spiral\Auth\Middlewares\AuthMiddleware::class,
//Sample middleware
\Middlewares\LocaleDetector::class,
Session\Http\SessionStarter::class,
//Middlewares\JsonParser::class,
Http\Cookies\CookieManager::class,
/*{{middlewares}}*/
],Entity must extend PasswordAwareInterface:
class Aware extends Record implements PasswordAwareInterface
{
//...
public function getPasswordHash()
{
return $this->password;
}
}Source must implement UsernameSourceInterface and needed methods:
class UserSource extends RecordSource implements UsernameSourceInterface
{
const RECORD = Aware::class;
public function findByUsername($username)
{
return $this->findOne([
'status' => 'active',
'username' => $username,
]);
}
}TODO: Add usage examples and firewalls.