library/Zend/InfoCard/Cipher/Pki/Rsa/Interface.php

   1 <?php
   2 /**
   3  * Zend Framework
   4  *
   5  * LICENSE
   6  *
   7  * This source file is subject to the new BSD license that is bundled
   8  * with this package in the file LICENSE.txt.
   9  * It is also available through the world-wide-web at this URL:
  10  * http://framework.zend.com/license/new-bsd
  11  * If you did not receive a copy of the license and are unable to
  12  * obtain it through the world-wide-web, please send an email
  13  * to license@zend.com so we can send you a copy immediately.
  14  *
  15  * @category   Zend
  16  * @package    Zend_InfoCard
  17  * @subpackage Zend_InfoCard_Cipher
  18  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  19  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  20  * @version    $Id: Interface.php 16214 2009-06-21 19:34:03Z thomas $
  21  */
  22
  23 /**
  24  * Zend_InfoCard_Cipher_PKI_Adapter_Abstract
  25  */
  26 require_once 'Zend/InfoCard/Cipher/Pki/Adapter/Abstract.php';
  27
  28 /**
  29  * The interface which defines the RSA Public-key encryption object
  30  *
  31  * @category   Zend
  32  * @package    Zend_InfoCard
  33  * @subpackage Zend_InfoCard_Cipher
  34  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  35  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  36  */
  37 interface Zend_InfoCard_Cipher_Pki_Rsa_Interface
  38 {
  39     /**
  40      * Decrypts RSA encrypted data using the given private key
  41      *
  42      * @throws Zend_InfoCard_Cipher_Exception
  43      * @param string $encryptedData The encrypted data in binary format
  44      * @param string $privateKey The private key in binary format
  45      * @param string $password The private key passphrase
  46      * @param integer $padding The padding to use during decryption (of not provided object value will be used)
  47      * @return string The decrypted data
  48      */
  49     public function decrypt($encryptedData, $privateKey, $password = null, $padding = Zend_InfoCard_Cipher_Pki_Adapter_Abstract::NO_PADDING);
  50 }