class.tx_saltedpasswords_salts_factory.php

Go to the documentation of this file.

<?php
/***************************************************************
*  Copyright notice
*
*  (c) 2009-2011 Marcus Krause <marcus#exp2009@t3sec.info>
*  All rights reserved
*
*  This script is part of the TYPO3 project. The TYPO3 project is
*  free software; you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation; either version 2 of the License, or
*  (at your option) any later version.
*
*  The GNU General Public License can be found at
*  http://www.gnu.org/copyleft/gpl.html.
*  A copy is found in the textfile GPL.txt and important notices to the license
*  from the author is found in LICENSE.txt distributed with these scripts.
*
*
*  This script is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/
/**
 * Contains class "tx_saltedpasswords_salts_factory"
 * that provides a salted hashing method factory.
 *
 * $Id: class.tx_saltedpasswords_salts_factory.php 10120 2011-01-18 20:03:36Z ohader $
 */


/**
 * Class that implements Blowfish salted hashing based on PHP's
 * crypt() function.
 *
 * @author      Marcus Krause <marcus#exp2009@t3sec.info>
 *
 * @since       2009-09-06
 * @package     TYPO3
 * @subpackage  tx_saltedpasswords
 */
class tx_saltedpasswords_salts_factory {
    /**
     * An instance of the salted hashing method.
     * This member is set in the getSaltingInstance() function.
     *
     * @var tx_saltedpasswords_abstract_salts
     */
    static protected $instance = NULL;


    /**
     * Obtains a salting hashing method instance.
     *
     * This function will return an instance of a class that implements
     * tx_saltedpasswords_abstract_salts.
     *
     * Use parameter NULL to reset the factory!
     *
     * @param   string      $saltedHash: (optional) salted hashed password to determine the type of used method from or NULL to reset the factory
     * @param   string      $mode: (optional) The TYPO3 mode (FE or BE) saltedpasswords shall be used for
     * @return  tx_saltedpasswords_abstract_salts   an instance of salting hashing method object
     */
    static public function getSaltingInstance($saltedHash = '', $mode = TYPO3_MODE) {
            // creating new instance when
            // * no instance existing
            // * a salted hash given to determine salted hashing method from
            // * a NULL parameter given to reset instance back to default method
        if (!is_object(self::$instance) || !empty($saltedHash) || is_NULL($saltedHash)) {

                // determine method by checking the given hash
            if (!empty($saltedHash)) {
                $result = self::determineSaltingHashingMethod($saltedHash);
                if(!$result) {
                    self::$instance = NULL;
                }
            } else {
                $classNameToUse = tx_saltedpasswords_div::getDefaultSaltingHashingMethod($mode);
                $availableClasses = $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/saltedpasswords']['saltMethods'];
                self::$instance = t3lib_div::getUserObj($availableClasses[$classNameToUse], 'tx_');
            }
        }

        return self::$instance;
    }

    /**
     * Method tries to determine the salting hashing method used for given salt.
     *
     * Method implicitly sets the instance of the found method object in the class property when found.
     *
     * @param   string      $saltedHash
     * @return  boolean     TRUE, if salting hashing method has been found, otherwise FALSE
     */
    static public function determineSaltingHashingMethod($saltedHash) {
        $methodFound = FALSE;
        $defaultMethods = $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/saltedpasswords']['saltMethods'];
        foreach($defaultMethods as $method) {
            $objectInstance = t3lib_div::getUserObj($method, 'tx_');
            if ($objectInstance instanceof tx_saltedpasswords_salts) {
                $methodFound = $objectInstance->isValidSaltedPW($saltedHash);
                if ($methodFound) {
                    self::$instance = $objectInstance;
                    break;
                }
            }
        }

        return $methodFound;
    }

    /**
     * Method sets a custom salting hashing method class.
     *
     * @param   string      $resource: object resource to use (e.g. 'EXT:saltedpasswords/classes/salts/class.tx_saltedpasswords_salts_blowfish.php:tx_saltedpasswords_salts_blowfish')
     * @return  tx_saltedpasswords_abstract_salts   an instance of salting hashing method object
     */
    static public function setPreferredHashingMethod($resource) {
        self::$instance = NULL;
        $objectInstance = t3lib_div::getUserObj($resource);
        if (is_object($objectInstance)
            && is_subclass_of($objectInstance, 'tx_saltedpasswords_abstract_salts')) {
                self::$instance = $objectInstance;
        }

        return self::$instance;
    }
}

?>