mvccore / ext-auth-basic
MvcCore - Extension - Auth - Basic - simple authentication extension, only to signin/signout user. Extension can use credentials defined in system `config.ini` or in database. Possibility to extend user, signin/signout forms, submit controller and extension class itself.
Requires
- php: >=5.4.0
- mvccore/ext-form: ^5.2.20
- mvccore/ext-form-field-button: ^5.2.2
- mvccore/ext-form-field-text: ^5.2.2
- mvccore/mvccore: ^5.2.33
README
Simple authentication extension, only to signin/signout user. Extension can use credentials defined in system config.ini
or in database. Possibility to extend user, signin/signout forms, submit controller and extension class itself.
Installation
composer require mvccore/ext-auth-basic
Usage
Add this to Bootstrap.php
or to very application beginning, before application routing.
\MvcCore\Ext\Auths\Basic::GetInstance() ->SetPasswordHashSalt('s9E56/QH6!a69sJML9aS$6s+') ->SetUserClass('\\MvcCore\\Ext\\Auths\\Users\\SystemConfig'); /* // or you can use database user: ->SetUserClass('\\MvcCore\\Ext\\Auths\\Users\\Database') ->SetTableStructureForDbUsers('users', array( 'id' => 'id', 'active' => 'active', 'userName' => 'user_name', 'passwordHash' => 'password_hash', 'fullName' => 'full_name', )); */
For system config users, you need to specify users in system.ini
like this:
[users] 0.userName = admin 0.fullName = Administrator 0.passwordHash = $2y$10$czlFNTYvUUg2IWE2OXNKTO8PB5xPGXz9i8IH7Fa7M0YsPlSLriJZu ; admin password is `demo`
To get sign in form into view in your application controller:
... public function IndexAction () { if ($this->user !== NULL) self::Redirect($this->Url('administration_index_page')); $this->view->SignInForm = \MvcCore\Ext\Auths\Basic::GetInstance() ->GetSignInForm() ->SetValues(array(// set signed in url to administration index page by default: 'successUrl' => $this->Url('administration_index_page'), )); } ...
To get sign out form into view in your application controller:
... public function PreDispatch () { parent::PreDispatch(); if ($this->viewEnabled && $this->user) { $this->view->SignOutForm =\MvcCore\Ext\Auths\Basic::GetInstance() ->GetSignOutForm() ->SetValues(array( 'successUrl' => $this->Url('login_page') )); } } ...
For any forms CSRF errors - you can call in base controller Init()
action:
... public function Init() { parent::Init(); // when any CSRF token is outdated or not the same - sign out user by default \MvcCore\Ext\Form::AddCsrfErrorHandler(function (\MvcCore\Ext\Form & $form, $errorMsg) { \MvcCore\Ext\Auths\Basics\User::LogOut(); self::Redirect($this->Url( 'Index:Index', array('absolute' => TRUE, 'sourceUrl' => rawurlencode($form->ErrorUrl)) )); }); } ...
To translate your signin and signout form visible elements, use:
\MvcCore\Ext\Auths\Basic::GetInstance()->SetTranslator(function ($key, $lang = NULL) { // your custom translator model/service: return \App\Models\Translator::GetInstance()->Translate($key, $lang); });