<?php

/**

 * Zend Framework

 *

 * LICENSE

 *

 * This source file is subject to the new BSD license that is bundled

 * with this package in the file LICENSE.txt.

 * It is also available through the world-wide-web at this URL:

 * http://framework.zend.com/license/new-bsd

 * If you did not receive a copy of the license and are unable to

 * obtain it through the world-wide-web, please send an email

 * to license@zend.com so we can send you a copy immediately.

 *

 * @category   Zend

 * @package    Zend_Auth

 * @subpackage Zend_Auth_Adapter_Http

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 * @version    $Id: Interface.php 20096 2010-01-06 02:05:09Z bkarwin $

 */

/**

 * Auth HTTP Resolver Interface

 *

 * Defines an interace to resolve a username/realm combination into a shared

 * secret usable by HTTP Authentication.

 *

 * @category   Zend

 * @package    Zend_Auth

 * @subpackage Zend_Auth_Adapter_Http

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 */

interface Zend_Auth_Adapter_Http_Resolver_Interface

{

    /**

     * Resolve username/realm to password/hash/etc.

     *

     * @param  string $username Username

     * @param  string $realm    Authentication Realm

     * @return string|false User's shared secret, if the user is found in the

     *         realm, false otherwise.

     */

    public function resolve($username, $realm);

}