Usr module
Usr module is inspired by the popular Yii-user module but written from scratch. It provides basic user actions like:
- logging in and out,
- password recovery and reset if expired
- registration with optional email verification,
- viewing and updating a minimal user profile along with changing password
- user managment
It's goal is to be easier to integrate into current projects by not requiring to modify existing user database table and model. Only the UserIdentity class is used to provide all business logic by implementing few provided interfaces.
Key differences from yii-user:
- smaller codebase, easier to read/review
- use good password hashing
- no need to modify current tables and models
- bundled mailer class
- built-in Hybridauth for logging using social site identities
- built-in Google Authenticator for two step authentication using one time passwords
Installation
Download and unpack in protected/modules.
Enable the module in the config/main.php file:
return array(
......
'modules'=>array(
'usr'=>array(
'userIdentityClass' => 'UserIdentity',
),
),
)
Requirements for the UserIdentity class are described in next chapter.
See UsrModule.php file for full options reference.
To be able to use user managment, create auth items using the createAuthItems
command and assign them to a role or users.
Identity interfaces
To be able to use all features of the Usr module, the UserIdentity class must implement some or all of the following interfaces.
Editable
This interface allows to create new identities (register) and update existing ones.
Active/disabled and email verification
This interface allows:
- finding existing identities using one of its attributes.
- generating and verifying an activation key used to verify email and send a recovery link
Remember to invalidate the email if it changes in the save() method from the Editable interface.
Password history
This interface allows password reset with optional tracking of used passwords. This allows to detect expired passwords and avoid reusing old passwords by users.
Hybridauth
This interface allows finding local identity associated with a remote one (from an external social site) and creating such associations.
One Time Password
This interface allow saving and retrieving a secret used to generate one time passwords. Also, last used password and counter used to generate last password are saved and retrieve to protect against reply attacks.
Profile Pictures
Allows users to upload a profile picture. The example identity uses Gravatar to provide a default picture.
Managable
Allows to manage users:
- update their profiles (and pictures)
- change passwords
- assign authorization roles
- activate/disable and mark email as verified
- see details as timestamps of account creation, last profile update and last visit
User model example
A sample ExampleUserIdentity and corresponding ExampleUser and ExampleUserUsedPassword models along with database migrations are provided respectively in the 'components', 'models' and 'migrations' folders.
They could be used as-is by extending from or copying to be modified to better suit a project.
To use the provided migrations it's best to copy them to your migrations directory and adjust the filenames and classnames to current date and time. Also, they could be modified to remove not needed features.
Diceware aka password generator
A simple implementation of a Diceware Passphrase generator is provided to aid users when they need to create a good, long but also easy to remember passphrase.
Read more at the Diceware Passphrase homepage.
Customize
Email templates
Set the setPathViews and setPathLayouts keys under the mailerConfig module option.
Registration/profile form
Altering the form is not currently possible. Ideas are welcome.
The whole module layout can be changed by setting the layout module option.
Translations
Feel free to send new and updated translations to the author.
Usage scenarios
Varios scenarios can be created by enabling or disabling following features:
- registration
- email verification
- account activation
Implementing those scenarios require some logic outside the scope of this module.
Public site
Users can register by themselves. Their accounts are activated instantly or after verifying email.
Moderated site
Users can register, but to allow them to log in an administrator must activate their accounts manually, optionally assigning an authorization profile. Email verification is optional and activation could trigger an email notification.
Configuration for Twitter Bootstrap
If using the bootstrap extension, the following configuration may be used:
'usr' => array(
'layout' => '//layouts/centered',
'formClass'=>'bootstrap.widgets.TbActiveForm',
'detailViewClass'=>'bootstrap.widgets.TbDetailView',
'formCssClass'=>'form well',
'alertCssClassPrefix'=>'alert alert-',
'submitButtonCssClass'=>'btn btn-primary',
'htmlCss' => array(
'errorSummaryCss' => 'alert alert-error',
'errorMessageCss' => 'text-error',
),
// mail
...mail config...
),
Besides that, all views could be overriden in a theme. A following skin can be used for user managment grid:
<?php
return array(
'default' => array(
'itemsCssClass' => 'table table-striped table-bordered table-condensed',
'pagerCssClass' => 'paging_bootstrap pagination',
),
);
License
MIT or BSD