Zend Framework: Zend_Auth_Storage_Cookie Component Proposal

Proposed Component Name	Zend_Auth_Storage_Cookie
Developer Notes	http://framework.zend.com/wiki/display/ZFDEV/Zend_Auth_Storage_Cookie
Proposers	Ben Scholzen
Revision	1.1 - 2 February 2008: Initial proposal. (wiki revision: 6)

Zend_Auth_Storage_Cookie is designed to be a persistent alternative to Zend_Auth_Storage_Session. Utilizing good design, the client side cookie will only consist of a unique id, with the server side storing a Zend_Cache object containing the matching unique id in addition to the auth information. Besides the obvious security advantages to this approach we avoid any issues of size limits of cookies. Most importantly, this method allows the programmer to decide when the auth storage is no longer need and avoids the current situations where PHP determines the life of sessions.

2. References

3. Component Requirements, Constraints, and Acceptance Criteria

This component will not save any data except an unique id in the user's cookie.
This component will store everything in a pre-defined Zend_Cache object.

4. Dependencies on Other Framework Components

Zend_Auth_Storage_Interface
Zend_Cache

5. Theory of Operation

The coder will first instantiate a new Zend_Cache Object, which is the supplied to the constructor of Zend_Auth_Storage_Cookie. This can then be supplied as storage to the Zend_Auth object.

6. Milestones / Tasks

Milestone 1: Component is approved.
Milestone 2: Working prototype checked into the incubator.
Milestone 3: Unit tests exist, work, and are checked into SVN.
Milestone 4: Initial documentation exists.

7. Class Index

Zend_Auth_Storage_Cookie

8. Use Cases

UC-01

// Create Zend_Cache object
$cache = new Zend_Cache(options ...);

// Create Zend_Auth_Storage_Cookie object with the Cache
$storage = new Zend_Auth_Storage_Cookie($cache);

// Set storage for Zend_Auth
Zend_Auth::getInstance()->setStorage($storage);

9. Class Skeletons

/**
 * @category   Zend
 * @package    Zend_Auth
 * @copyright  Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
class Zend_Auth_Storage_Cookie implements Zend_Auth_Storage_Interface
{
    /**
     * Default cookie name
     */
    const COOKIE_NAME_DEFAULT = 'Zend_Auth';

    /**
     * Cache object where to save auth data
     *
     * @var Zend_Cache
     */
    protected $_cache;

    /**
     * Cookie name
     *
     * @var string
     */
    protected $_cookieName;


    /**
     * Sets cookie storage options and initializes the cookie
     *
     * @param Zend_Cache $cache
     * @param string $cookieName
     */
    public function __construct(Zend_Cache $cache, $cookieName = self::COOKIE_NAME_DEFAULT)
    {}

    /**
     * Returns the name of the used cookie
     *
     * @return string
     */
    public function getCookieName()
    {}

    /**
     * Defined by Zend_Auth_Storage_Interface
     *
     * @return boolean
     */
    public function isEmpty()
    {}

    /**
     * Defined by Zend_Auth_Storage_Interface
     *
     * @return mixed
     */
    public function read()
    {}

    /**
     * Defined by Zend_Auth_Storage_Interface
     *
     * @param  mixed $contents
     * @return void
     */
    public function write($contents)
    {}

    /**
     * Defined by Zend_Auth_Storage_Interface
     *
     * @return void
     */
    public function clear()
    {}
}

Page Operations

Browse Space

Zend_Auth_Storage_Cookie - Ben Scholzen

Labels