interface/modules/zend_modules/library/Zend/Crypt/PublicKey/Rsa/PrivateKey.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Crypt\PublicKey\Rsa;
  11
  12 /**
  13  * RSA private key
  14  */
  15 class PrivateKey extends AbstractKey
  16 {
  17     /**
  18      * Public key
  19      *
  20      * @var PublicKey
  21      */
  22     protected $publicKey = null;
  23
  24     /**
  25      * Create private key instance from PEM formatted key file
  26      *
  27      * @param  string      $pemFile
  28      * @param  string|null $passPhrase
  29      * @return PrivateKey
  30      * @throws Exception\InvalidArgumentException
  31      */
  32     public static function fromFile($pemFile, $passPhrase = null)
  33     {
  34         if (!is_readable($pemFile)) {
  35             throw new Exception\InvalidArgumentException(
  36                 "PEM file '{$pemFile}' is not readable"
  37             );
  38         }
  39
  40         return new static(file_get_contents($pemFile), $passPhrase);
  41     }
  42
  43     /**
  44      * Constructor
  45      *
  46      * @param  string $pemString
  47      * @param  string $passPhrase
  48      * @throws Exception\RuntimeException
  49      */
  50     public function __construct($pemString, $passPhrase = null)
  51     {
  52         $result = openssl_pkey_get_private($pemString, $passPhrase);
  53         if (false === $result) {
  54             throw new Exception\RuntimeException(
  55                 'Unable to load private key; openssl ' . openssl_error_string()
  56             );
  57         }
  58
  59         $this->pemString          = $pemString;
  60         $this->opensslKeyResource = $result;
  61         $this->details            = openssl_pkey_get_details($this->opensslKeyResource);
  62     }
  63
  64     /**
  65      * Get the public key
  66      *
  67      * @return PublicKey
  68      */
  69     public function getPublicKey()
  70     {
  71         if ($this->publicKey === null) {
  72             $this->publicKey = new PublicKey($this->details['key']);
  73         }
  74
  75         return $this->publicKey;
  76     }
  77
  78     /**
  79      * Encrypt using this key
  80      *
  81      * @param  string $data
  82      * @param  integer $padding
  83      * @return string
  84      * @throws Exception\RuntimeException
  85      * @throws Exception\InvalidArgumentException
  86      */
  87     public function encrypt($data, $padding = OPENSSL_PKCS1_PADDING)
  88     {
  89         if (empty($data)) {
  90             throw new Exception\InvalidArgumentException('The data to encrypt cannot be empty');
  91         }
  92
  93         $encrypted = '';
  94         $result = openssl_private_encrypt($data, $encrypted, $this->getOpensslKeyResource(), $padding);
  95         if (false === $result) {
  96             throw new Exception\RuntimeException(
  97                 'Can not encrypt; openssl ' . openssl_error_string()
  98             );
  99         }
 100
 101         return $encrypted;
 102     }
 103
 104     /**
 105      * Decrypt using this key
 106      * Starting in 2.4.9/2.5.2, we changed the default padding to
 107      * OPENSSL_PKCS1_OAEP_PADDING to prevent Bleichenbacher's chosen-ciphertext
 108      * attack.
 109      *
 110      * @see http://archiv.infsec.ethz.ch/education/fs08/secsem/bleichenbacher98.pdf
 111      * @param  string $data
 112      * @param  integer $padding
 113      * @return string
 114      * @throws Exception\RuntimeException
 115      * @throws Exception\InvalidArgumentException
 116      */
 117     public function decrypt($data, $padding = OPENSSL_PKCS1_OAEP_PADDING)
 118     {
 119         if (!is_string($data)) {
 120             throw new Exception\InvalidArgumentException('The data to decrypt must be a string');
 121         }
 122         if ('' === $data) {
 123             throw new Exception\InvalidArgumentException('The data to decrypt cannot be empty');
 124         }
 125
 126         $decrypted = '';
 127         $result = openssl_private_decrypt($data, $decrypted, $this->getOpensslKeyResource(), $padding);
 128         if (false === $result) {
 129             throw new Exception\RuntimeException(
 130                 'Can not decrypt; openssl ' . openssl_error_string()
 131             );
 132         }
 133
 134         return $decrypted;
 135     }
 136
 137     /**
 138      * @return string
 139      */
 140     public function toString()
 141     {
 142         return $this->pemString;
 143     }
 144 }