Merge pull request #10 from MayMeow/allow-exporting-rsaparameters

Implement ability to export and import RSA Parameters

Author: 栄茉

CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+## [Unreleased](https://github.com/maymeow/php-cryptography/tree/HEAD)
+
+[Full Changelog](https://github.com/maymeow/php-cryptography/compare/c0f4aded5b4196e7686f32ee84f6fd8651a753df...HEAD)
+
+**Implemented enhancements:**
+
+- Upgrade for PHP 8 [\#8](https://github.com/MayMeow/php-cryptography/issues/8)
+
+**Fixed bugs:**
+
+- RSAParameters keys cannot be string [\#2](https://github.com/MayMeow/php-cryptography/issues/2)
+
+**Merged pull requests:**
+
+- Update to using php 8 [\#9](https://github.com/MayMeow/php-cryptography/pull/9) ([MayMeow](https://github.com/MayMeow))
+- :wrench: add phpstan [\#6](https://github.com/MayMeow/php-cryptography/pull/6) ([MayMeow](https://github.com/MayMeow))
+- Update rsacsp [\#5](https://github.com/MayMeow/php-cryptography/pull/5) ([MayMeow](https://github.com/MayMeow))
+- Remove string type from keys in RSAParameters [\#3](https://github.com/MayMeow/php-cryptography/pull/3) ([MayMeow](https://github.com/MayMeow))
+- ADD RSA parameters WIP [\#1](https://github.com/MayMeow/php-cryptography/pull/1) ([MayMeow](https://github.com/MayMeow))
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

README.md

@@ -79,8 +79,45 @@ $rsa->setParameters($parameters);
 $encryptedTest = $rsa->encrypt($plainText);
 
 $decryptedText = $rsa->decrypt($encryptedTest);
+```
+
+### Exporting and importing keys
+
+To use keys for later in case of encrypt/decrypt data is important to store them on some place. For this I created Readers
+and Writers. To export keys use Writer as example shows bellow:
+
+```php
+ $parameters = new RSAParameters();
+$parameters->generateKeys();
+$locator = new TestingParametersLocator();
 
+$writer = new RsaParametersWriter($locator);
+$writer->write($parameters);
 ```
+If you want implement own Writers they must implement `MayMeow\Cryptography\Tools\RsaParametersWriterInterface`.
+
+Importing keys can be done as on example below:
+
+```php
+$reader = new RsaParametersReader($locator);
+$parameters2 = $reader->read();
+
+$csp2 = new RSACryptoServiceProvider();
+$csp2->setParameters($parameters2);
+```
+
+Like on writers you can implement your own Readers too. If you do so your new reader have to implement
+`MayMeow\Cryptography\Tools\RsaParametersReaderInterface`
+
+### Locators
+
+Both reader and writer in above example is using Locator. Locators are classes which can return string representation
+of location where are stored RSAParameters parts. This can be database table, model, table field, path in filesystem
+and more. Interfaces for Reader and Writer not required to use one, but I recommend it.
+
+If you want implement your own locator, this has to implement `MayMeow\Cryptography\Tools\RSAParametersLocatorInterface`.
+
+As example, you can check Tools in test folder.
 
 ### Cryptographic key derivation
 

composer.json

@@ -29,6 +29,7 @@
     "scripts": {
         "test": "phpunit tests",
         "cs-check": "phpcs --standard=PSR2 src",
+        "cs-fix": "phpcbf --standard=PSR2 src",
         "stan": "phpstan analyse"
     }
 }

generate-changelog.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+docker run -it --rm -v "$(pwd)":/usr/local/src/your-app githubchangeloggenerator/github-changelog-generator -u maymeow -p php-cryptography

phpunit.xml.dist

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit bootstrap="tests/bootstrap.php" />

src/AESCryptoServiceProvider.php

@@ -58,6 +58,7 @@ public function setKey(string $key): AESCryptoServiceProvider
     /**
      * Generate key
      *
+     * @todo Change return type to string only, throw exception instead
      * @return bool|string
      */
     public function generateKey()
@@ -76,6 +77,7 @@ public function generateKey()
     /**
      * Generate IV
      *
+     * @todo Change return type to string only, throw exception instead
      * @return bool|string
      */
     public function generateIV()

src/CryptoKey.php

@@ -11,7 +11,7 @@ public function helloWorld() : string
     }
 
     /**
-     * Derivate cryptographic key from given password
+     * Derive cryptographic key from given password
      *
      * @param string $password
      * @param string $salt

src/Exceptions/FileReadException.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace MayMeow\Cryptography\Exceptions;
+
+use Throwable;
+
+class FileReadException extends \Exception
+{
+    /**
+     * @param string $message
+     * @param int $code
+     * @param Throwable|null $previous
+     */
+    public function __construct(string $message = "Cannot read file", int $code = 10, Throwable $previous = null)
+    {
+        parent::__construct($message, $code, $previous);
+    }
+}

src/RSACryptoServiceProvider.php

@@ -3,6 +3,7 @@
 namespace MayMeow\Cryptography;
 
 use MayMeow\Cryptography\Exceptions\NotImplementedException;
+use MayMeow\Cryptography\Tools\RsaParametersReaderInterface;
 
 class RSACryptoServiceProvider
 {
@@ -42,6 +43,8 @@ public function decrypt(string $encryptedText) : string
     }
 
     /**
+     * Encrypt data with pricate key
+     *
      * @param string $plainText
      * @return string
      */
@@ -56,6 +59,8 @@ public function privateEncrypt(string $plainText) : string
     }
 
     /**
+     * Decrypt data with public key
+     *
      * @param string $encryptedText
      * @return string
      */
@@ -84,6 +89,8 @@ protected function open() : string
     }
 
     /**
+     * Sign data with key and return signature
+     *
      * @param string $data
      * @return string
      */
@@ -97,6 +104,8 @@ public function sign(string $data) : string
     }
 
     /**
+     * Verify if signed data are same as in time of create signature
+     *
      * @param string $data
      * @param string $signature
      * @return bool
@@ -128,8 +137,13 @@ public function getFingerPrint(string $publicKey = null) : string
     }
 
     /**
+     * Returns private key
+     *
      * @return \OpenSSLAsymmetricKey|string
      * @throws Exceptions\DecryptPrivateKeyException
+     *
+     * @deprecated Passphrase can be set with setting private key instead
+     * @see RsaParameters::setPrivateKey()
      */
     private function getPrivateKey() : \OpenSSLAsymmetricKey|string
     {

src/RSAParameters.php

@@ -21,6 +21,8 @@ public function __construct()
     }
 
     /**
+     * Generate keypair and passphrase to decrypt private key
+     *
      * @param string|null $passphrase
      * @param array|null $configArgs
      * @return $this
@@ -71,14 +73,20 @@ public function getPrivateKey() : \OpenSSLAsymmetricKey|string
     }
 
     /**
+     * Set private key from string representation and its passphrase
+     *
      * @param string $privateKey
+     * @param string $passphrase
      */
-    public function setPrivateKey(string $privateKey): void
+    public function setPrivateKey(string $privateKey, string $passphrase): void
     {
+        $this->passphrase = $passphrase;
         $this->privateKey = $privateKey;
     }
 
     /**
+     * Returns public key as string
+     *
      * @return string
      */
     public function getPublicKey() : string
@@ -87,6 +95,8 @@ public function getPublicKey() : string
     }
 
     /**
+     * Set public key from string representation
+     *
      * @param string $publicKey
      */
     public function setPublicKey(string $publicKey): void
@@ -95,6 +105,8 @@ public function setPublicKey(string $publicKey): void
     }
 
     /**
+     * Returns passphrase for private key decryption
+     *
      * @return string
      */
     public function getPassphrase(): string
@@ -103,6 +115,8 @@ public function getPassphrase(): string
     }
 
     /**
+     * Set passphrase for private key
+     *
      * @param string $passphrase
      * @return $this
      */