class.tx_rsaauth_abstract_backend.php

Go to the documentation of this file.

<?php
/***************************************************************
*  Copyright notice
*
*  (c) 2009-2011 Dmitry Dulepov <dmitry@typo3.org>
*  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.
*
*  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!
***************************************************************/

/**
 * [CLASS/FUNCTION INDEX of SCRIPT]
 *
 * $Id: class.tx_rsaauth_abstract_backend.php 10120 2011-01-18 20:03:36Z ohader $
 */

require_once(t3lib_extMgm::extPath('rsaauth', 'sv1/backends/class.tx_rsaauth_keypair.php'));

/**
 * This class contains an abstract SSL backend for the TYPO3 RSA authentication
 * service.
 *
 * There are two steps:
 *  - prepare data for encoding
 *  - decode incoming data
 *
 * To prepare data for encoding, the createNewKeyPair() method should be called.
 * This method returns an instance of tx_rsaauth_keypair class, which contains
 * the private and public keys. Public key is sent to the client to encode data.
 * Private key should be stored somewhere (preferrably in user's session).
 *
 * To decode data, the decrypt() method should be called with the private key
 * created at the previous step and the data to decode. If the data is decoded
 * successfully, the result is a string. Otherwise it is null.
 *
 * @author  Dmitry Dulepov <dmitry@typo3.org>
 * @package TYPO3
 * @subpackage  tx_rsaauth
 */
abstract class tx_rsaauth_abstract_backend {

    /**
     * Error message for the last operation. Derieved classes should always set
     * or clear this variable inside the createNewKeyPair() or decypt().
     *
     * @var string
     */
    protected   $error = '';

    /**
     * Creates a new key pair for the encryption.
     *
     * @return  tx_rsaauth_keypair  A new key pair or null in case of error
     */
    abstract public function createNewKeyPair();

    /**
     * Decripts the data using the private key.
     *
     * @param   string  $privateKey The private key (obtained from a call to createNewKeyPair())
     * @param   string  $data   Data to decrypt (base64-encoded)
     * @return  string  Decrypted data or null in case of a error
     */
    abstract public function decrypt($privateKey, $data);

    /**
     * Checks if this backend is available for calling.
     *
     * @return  void
     */
    abstract public function isAvailable();

    /**
     * Retrieves a error message.
     *
     * @return  string  A error message or empty string if there were no error
     */
    public function getLastError() {
        return $this->error;
    }
}

if (defined('TYPO3_MODE') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['ext/rsaauth/sv1/backend/class.tx_rsaauth_abstract_backend.php'])) {
    include_once($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['ext/rsaauth/sv1/backend/class.tx_rsaauth_abstract_backend.php']);
}

?>