Skip to content
This repository

This module has been migrated to ZfcUser under the ZF-Commons organization. Please update your submodule references and bookmarks.

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 config
Octocat-spinner-32 data
Octocat-spinner-32 src
Octocat-spinner-32 views
Octocat-spinner-32 Module.php
Octocat-spinner-32 README.md
Octocat-spinner-32 autoload_classmap.php
Octocat-spinner-32 autoload_function.php
Octocat-spinner-32 autoload_register.php
README.md

EdpUser

Version 0.0.1 Created by Evan Coury

Introduction

EdpUser is a user registration and authentication module for Zend Framework 2, which can utilize either Doctrine2 or Zend\Db. It provides the foundations for adding user authentication and registration to your ZF2 site. It is built to be very simple and easily to extend.

Requirements

Features / Goals

  • Authenticate via username, email, or both (can opt out of the concept of username and use strictly email) [COMPLETE]
  • User registration [COMPLETE]
  • Forms protected against CSRF [COMPLETE]
  • Registration form protected with CAPTCHA [IN PROGRESS] (Needs more options)
  • Out-of-the-box support for Doctrine2 and Zend\Db [IN PROGRESS]
  • Robust event system to allow for extending [IN PROGRESS]
  • Support for additional authentication mechanisms via plugins (Google, Facebook, LDAP, etc) [INCOMPLETE]
  • Optional E-mail address verification [INCOMPLETE]
  • Forgot Password [INCOMPLETE]
  • Provide ActionController plugin and view helper [INCOMPLETE]

Installation

Main Setup

  1. Install the EdpCommon ZF2 module by cloning it into ./vendors/ and enabling it in your application.config.php file.
  2. Clone this project into your ./vendors/ directory and enable it in your application.config.php file.
  3. Import the SQL schema located in ./vendors/EdpUser/data/schema.sql.
  4. Copy ./vendors/EdpUser/config/module.edpuser.config.php.dist to ./config/autoload/module.edpuser.config.php.
  5. Follow the Post-Install instructions below for your preferred database access layer (Doctrine2 or Zend\Db)

Post-Install: Doctrine2

  1. Install and configure the SpiffyDoctrine ZF2 module per the installation instructions.

Navigate to http://yourproject/user and you should land on a login page.

Post-Install: Zend\Db

  1. If you do not already have a PDO connection set up via DI, put the following in ./config/autoload/database.config.php:

    <?php
    // ./config/autoload/database.config.php
    return array(
        'di' => array(
            'instance' => array(
                'alias' => array(
                    'masterdb' => 'PDO',
                ),
                'masterdb' => array(
                    'parameters' => array(
                        'dsn'            => 'mysql:dbname=CHANGEME;host=CHANGEME',
                        'username'       => 'CHANGEME',
                        'passwd'         => 'CHANGEME',
                        'driver_options' => array(PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES \'UTF8\''),
                    ),
                ),
            ),
        ),
    );
    
  2. Now, specify the DI alias for your PDO connection in ./configs/autoload/module.edpuser.config.php, under the 'pdo' setting. If you created the ./configs/autoload/database.config.php file in the previous step, the alias you'll specify is 'masterdb'.

  3. Finally, in ./configs/autoload/module.edpuser.config.php, change the value of the db_abstraction setting from 'doctrine' to 'zend_db'.

Navigate to http://yourproject/user and you should land on a login page.

Password Security

DO NOT CHANGE THE PASSWORD HASH SETTINGS FROM THEIR DEFAULTS unless A) you have done sufficient research and fully understand exactly what you are changing, AND B) you have a very specific reason to deviate from the default settings.

If you are planning on changing the default password hash settings, please read the following:

The password hash settings may be changed at any time without invalidating existing user accounts. Existing user passwords will be re-hashed automatically on their next successful login.

WARNING: Changing the default password hash settings can cause serious problems such as making your hashed passwords more vulnerable to brute force attacks or making hashing so expesnive that login and registration is unacceptably slow for users and produces a large burden on your server(s). The default settings provided are a very reasonable balance between the two, suitable for computing power in 2011.

Options

The EdpUser module has some options to allow you to quickly customize the basic functionality. After installing EdpUser, copy ./vendor/EdpUser/config/module.edpuser.config.php to ./config/autoload/module.config.php and change the values as desired.

The following options are available:

  • user_model_class - Name of Entity class to use. Useful for using your own entity class instead of the default one provided. Default is EdpUser\Model\User.
  • enable_username - Boolean value, enables username field on the registration form, and allows users to log in using their username OR email address. Default is false.
  • enable_display_name - Boolean value, enables a display name field on the registration form. Default value is false.
  • require_activation - Boolean value, require that the user verify their email address to 'activate' their account. Default value is false. (Note, this doesn't actually work yet, but defaults an 'active' field in the DB to 0.)
  • login_after_registration - Boolean value, automatically logs the user in after they successfully register. Default value is false.
  • registration_form_captcha - Boolean value, determines if a captcha should be utilized on the user registration form. Default value is true. (Note, right now this only utilizes a weak Zend\Text\Figlet CAPTCHA, but I have plans to make all Zend\Captcha adapters work.)
  • password_hash_algorithm - Name of the hashing algorithm to use for hashing. Supported algorithms are blowfish, sha512, and sha256. Default is blowfish.
  • blowfish_cost - Only used if password_hash_algorithm is set to blowfish. This should be an integer between 4 and 31. The number represents the base-2 logarithm of the iteration count used for hashing. Default is 10 (about 10 hashes per second on an i5).
  • sha256_rounds - Only used if password_hash_algorithm is set to sha256. This should be an integer between 1000 and 999,999,999. The number represents the iteration count used for hashing. Default is 5000.
  • sha512_rounds - Only used if password_hash_algorithm is set to sha512. This should be an integer between 1000 and 999,999,999. The number represents the iteration count used for hashing. Default is 5000.

Overriding / extending the User entity

Sometimes you may want to override the default user entity with your own. With EdpUser, this is very easy.

First, create your extended User entity:

<?php
// ./module/Application/src/Application/EdpUser/Model/User.php

namespace Application\EdpUser\Model;

use Doctrine\ORM\Mapping as ORM,
    EdpUser\ModelBase\UserBase;

/**
 * @ORM\Entity
 * @ORM\Table(name="user")
 */
class User extends UserBase
{
    /**
     * You can add more stuff to the User entity here.
     */
}

Next, tell EdpUser to utilize your new entity class:

// ./config/autoload/module.edpuser.config.php
'user_model_class' => 'Application\EdpUser\Model\User',

If you're using Doctrine2, you'll also need to override the EdpUser entity path:

// ./config/autoload/module.edpuser.custom.config.php (New file)
<?php
return array(
    'di' => array(
        'instance' => array(
            'doctrine_driver_chain' => array(
                'parameters' => array(
                    'drivers' => array(
                        'edpuser_annotationdriver' => array(
                            'class'     => 'Doctrine\ORM\Mapping\Driver\AnnotationDriver',
                            'namespace' => 'Application\EdpUser\Model',
                            'paths'     => array(dirname(__DIR__) . '/module/Application/src/Application/EdpUser/Model'),
                        ),
                    ),
                ),
            ),
        ),
    ),
);

Common Use-Cases

Checking if a user is logged in from an ActionController

if ($this->getLocator()->get('edpuser_user_service')->getAuthService()->hasIdentity()) {
    //...
}

Retrieving a user's identity from an ActionController

$user = $this->getLocator()->get('edpuser_user_service')->getAuthService()->getIdentity();
return array('user' => $user);

Note: getIdentity() returns an instance of EdpUser\Entity\User.

Logging a user out from an ActionController

$this->getLocator()->get('edpuser_user_service')->getAuthService()->clearIdentity();
Something went wrong with that request. Please try again.