Changed options for createUserSignatures.

Author: andrew-svirin

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.5
+
+* Changed `options` for `createUserSignatures`.
+
 ## 2.4
 
 * Fixed HVE order type.

README.md

@@ -57,7 +57,7 @@ use EbicsApi\Ebics\Models\X509\BankX509Generator;
 // Prepare `workspace` dir in the __PATH_TO_WORKSPACES_DIR__ manually.
 // "__EBICS_VERSION__" should have value "VERSION_30" for EBICS 3.0
 $keyringPath = __PATH_TO_WORKSPACES_DIR__ . '/workspace/keyring.json';
-$keyringManager = new FileKeyringManager(new KeyringFactory);
+$keyringManager = new FileKeyringManager();
 if (is_file($keyringPath)) {
     $keyring = $keyringManager->loadKeyring($keyringPath, __PASSWORD__, __EBICS_VERSION__);
 } else {

src/Contracts/Crypt/RSAInterface.php

@@ -2,6 +2,7 @@
 
 namespace EbicsApi\Ebics\Contracts\Crypt;
 
+use EbicsApi\Ebics\Models\Crypt\Key;
 use EbicsApi\Ebics\Models\Crypt\KeyPair;
 use EbicsApi\Ebics\Models\Crypt\RSA;
 

src/Contracts/EbicsClientInterface.php

@@ -35,7 +35,7 @@ interface EbicsClientInterface
 
     /**
      * Create user signatures A, E and X on first launch.
-     * @param array|null $options Setup to specify custom certificate, private_key and version
+     * @param array|null $options Setup to specify custom certificate, private, public keys and version
      * for Electronic Signature, Authorization and Identification, Encryption details.
      */
     public function createUserSignatures(?array $options = null): void;

src/Contracts/KeyStorageInterface.php

@@ -0,0 +1,68 @@
+<?php
+
+namespace EbicsApi\Ebics\Contracts;
+
+use EbicsApi\Ebics\Models\Crypt\Key;
+
+/**
+ * KeyStorageInterface.
+ *
+ * @license http://www.opensource.org/licenses/mit-license.html  MIT License
+ * @author Andrew Svirin
+ */
+interface KeyStorageInterface
+{
+    /**
+     * Write public key to storage.
+     *
+     * @param Key $key
+     *
+     * @return string
+     */
+    public function writePublicKey(Key $key): string;
+
+    /**
+     * Read public key from storage.
+     *
+     * @param string $key
+     *
+     * @return Key
+     */
+    public function readPublicKey(string $key): Key;
+
+    /**
+     * Write private key to storage.
+     *
+     * @param Key $key
+     *
+     * @return string
+     */
+    public function writePrivateKey(Key $key): string;
+
+    /**
+     * Read private key from storage.
+     *
+     * @param string $key
+     *
+     * @return Key
+     */
+    public function readPrivateKey(string $key): Key;
+
+    /**
+     * Write certificate to storage.
+     *
+     * @param string $certificate
+     *
+     * @return string
+     */
+    public function writeCertificate(string $certificate): string;
+
+    /**
+     * Read certificate from storage.
+     *
+     * @param string $certificate
+     *
+     * @return string
+     */
+    public function readCertificate(string $certificate): string;
+}

src/Contracts/SignatureInterface.php

@@ -2,6 +2,8 @@
 
 namespace EbicsApi\Ebics\Contracts;
 
+use EbicsApi\Ebics\Models\Crypt\Key;
+
 /**
  * EBICS SignatureInterface representation.
  *
@@ -26,14 +28,14 @@ interface SignatureInterface
     public function getType(): string;
 
     /**
-     * @return string
+     * @return Key
      */
-    public function getPublicKey(): string;
+    public function getPublicKey(): Key;
 
     /**
-     * @return string|null
+     * @return Key|null
      */
-    public function getPrivateKey(): ?string;
+    public function getPrivateKey(): ?Key;
 
     /**
      * @param string|null $certificateContent

src/EbicsBankLetter.php

@@ -5,6 +5,8 @@
 use EbicsApi\Ebics\Contracts\BankLetter\FormatterInterface;
 use EbicsApi\Ebics\Factories\BankLetterFactory;
 use EbicsApi\Ebics\Factories\CertificateX509Factory;
+use EbicsApi\Ebics\Factories\Crypt\AESFactory;
+use EbicsApi\Ebics\Factories\Crypt\RSAFactory;
 use EbicsApi\Ebics\Factories\EbicsFactoryV24;
 use EbicsApi\Ebics\Factories\EbicsFactoryV25;
 use EbicsApi\Ebics\Factories\EbicsFactoryV30;
@@ -18,6 +20,7 @@
 use EbicsApi\Ebics\Services\BankLetter\Formatter\TxtBankLetterFormatter;
 use EbicsApi\Ebics\Services\BankLetterService;
 use EbicsApi\Ebics\Services\CryptService;
+use EbicsApi\Ebics\Services\RandomService;
 use LogicException;
 
 /**
@@ -33,9 +36,13 @@ final class EbicsBankLetter
     private BankLetterFactory $bankLetterFactory;
     private CryptService $cryptService;
 
-    public function __construct()
+    public function __construct(array $options = [])
     {
-        $this->cryptService = new CryptService();
+        $this->cryptService = new CryptService(
+            new RSAFactory($options['rsa_class_map'] ?? null),
+            new AESFactory(),
+            new RandomService()
+        );
         $this->bankLetterService = new BankLetterService(
             $this->cryptService,
             new SignatureBankLetterFactory(),

src/EbicsClient.php

@@ -21,7 +21,9 @@
 use EbicsApi\Ebics\Exceptions\PasswordEbicsException;
 use EbicsApi\Ebics\Factories\BufferFactory;
 use EbicsApi\Ebics\Factories\CertificateX509Factory;
+use EbicsApi\Ebics\Factories\Crypt\AESFactory;
 use EbicsApi\Ebics\Factories\Crypt\BigIntegerFactory;
+use EbicsApi\Ebics\Factories\Crypt\RSAFactory;
 use EbicsApi\Ebics\Factories\DocumentFactory;
 use EbicsApi\Ebics\Factories\EbicsExceptionFactory;
 use EbicsApi\Ebics\Factories\EbicsFactoryV24;
@@ -35,6 +37,9 @@
 use EbicsApi\Ebics\Handlers\OrderDataHandler;
 use EbicsApi\Ebics\Handlers\ResponseHandler;
 use EbicsApi\Ebics\Models\Bank;
+use EbicsApi\Ebics\Models\Crypt\Key;
+use EbicsApi\Ebics\Models\Crypt\KeyPair;
+use EbicsApi\Ebics\Models\Crypt\RSA;
 use EbicsApi\Ebics\Models\DownloadOrderResult;
 use EbicsApi\Ebics\Models\DownloadSegment;
 use EbicsApi\Ebics\Models\DownloadTransaction;
@@ -50,6 +55,7 @@
 use EbicsApi\Ebics\Models\X509\ContentX509Generator;
 use EbicsApi\Ebics\Services\CryptService;
 use EbicsApi\Ebics\Services\CurlHttpClient;
+use EbicsApi\Ebics\Services\RandomService;
 use EbicsApi\Ebics\Services\SchemaValidator;
 use EbicsApi\Ebics\Services\XmlService;
 use EbicsApi\Ebics\Services\ZipService;
@@ -104,10 +110,12 @@ public function __construct(Bank $bank, User $user, Keyring $keyring, array $opt
             throw new LogicException(sprintf('Version "%s" is not implemented', $keyring->getVersion()));
         }
 
+        $rsaFactory = new RSAFactory($options['rsa_class_map'] ?? null);
+
         $this->segmentFactory = new SegmentFactory();
-        $this->cryptService = new CryptService();
+        $this->cryptService = new CryptService($rsaFactory, new AESFactory(), new RandomService());
         $this->zipService = new ZipService();
-        $this->signatureFactory = new SignatureFactory();
+        $this->signatureFactory = new SignatureFactory($rsaFactory);
         $this->bufferFactory = new BufferFactory($options['buffer_filename'] ?? 'php://memory');
 
         $this->orderDataHandler = $ebicsFactory->createOrderDataHandler(
@@ -1330,10 +1338,9 @@ private function createUserSignature(string $type, ?array $details = null): Sign
                     $keyPair = $this->cryptService->generateKeyPair($this->keyring->getPassword());
                     $certificateGenerator = $this->keyring->getCertificateGenerator();
                 } else {
-                    $keyPair = $this->cryptService->changePrivateKeyPassword(
-                        $details['privatekey'],
-                        $details['password'],
-                        $this->keyring->getPassword()
+                    $keyPair = new KeyPair(
+                        new Key($details['publickey'], $details['publickey_type']),
+                        new Key($details['privatekey'], $details['privatekey_type'])
                     );
                     $certificateGenerator = new ContentX509Generator();
                     $certificateGenerator->setAContent($details['certificate']);
@@ -1393,7 +1400,10 @@ public function checkKeyring(): bool
     public function changeKeyringPassword(string $newPassword): void
     {
         $keyPair = $this->cryptService->changePrivateKeyPassword(
-            $this->keyring->getUserSignatureA()->getPrivateKey(),
+            new KeyPair(
+                $this->keyring->getUserSignatureA()->getPublicKey(),
+                $this->keyring->getUserSignatureA()->getPrivateKey()
+            ),
             $this->keyring->getPassword(),
             $newPassword
         );
@@ -1407,7 +1417,10 @@ public function changeKeyringPassword(string $newPassword): void
         $this->keyring->setUserSignatureA($signature);
 
         $keyPair = $this->cryptService->changePrivateKeyPassword(
-            $this->keyring->getUserSignatureX()->getPrivateKey(),
+            new KeyPair(
+                $this->keyring->getUserSignatureX()->getPublicKey(),
+                $this->keyring->getUserSignatureX()->getPrivateKey()
+            ),
             $this->keyring->getPassword(),
             $newPassword
         );
@@ -1421,7 +1434,10 @@ public function changeKeyringPassword(string $newPassword): void
         $this->keyring->setUserSignatureX($signature);
 
         $keyPair = $this->cryptService->changePrivateKeyPassword(
-            $this->keyring->getUserSignatureE()->getPrivateKey(),
+            new KeyPair(
+                $this->keyring->getUserSignatureE()->getPublicKey(),
+                $this->keyring->getUserSignatureE()->getPrivateKey()
+            ),
             $this->keyring->getPassword(),
             $newPassword
         );

src/Factories/Crypt/RSAFactory.php

@@ -3,6 +3,7 @@
 namespace EbicsApi\Ebics\Factories\Crypt;
 
 use EbicsApi\Ebics\Contracts\Crypt\RSAInterface;
+use EbicsApi\Ebics\Models\Crypt\Key;
 use EbicsApi\Ebics\Models\Crypt\RSA;
 
 /**
@@ -14,41 +15,56 @@
 final class RSAFactory
 {
     /**
+     * @var array<int, class-string<RSAInterface>>
+     */
+    private array $classMap;
+
+    /**
+     * @param array<int, class-string<RSAInterface>> $classMap
+     */
+    public function __construct(?array $classMap = null)
+    {
+        $this->classMap = $classMap ?? [
+            RSA::PRIVATE_FORMAT_PKCS1 => RSA::class,
+            RSA::PUBLIC_FORMAT_PKCS1 => RSA::class,
+        ];
+    }
+
+    /**
+     * @param int $type
      * @return RSAInterface
      */
-    public function create(): RSAInterface
+    public function create(int $type): RSAInterface
     {
-        return new RSA();
+        return new $this->classMap[$type];
     }
 
     /**
      * Create RSA from private key.
      *
-     * @param string $privateKey
+     * @param Key $privateKey
      * @param string $password
-     *
      * @return RSAInterface
      */
-    public function createPrivate(string $privateKey, string $password): RSAInterface
+    public function createPrivate(Key $privateKey, string $password): RSAInterface
     {
-        $rsa = $this->create();
+        $rsa = $this->create($privateKey->getType());
         $rsa->setPassword($password);
-        $rsa->loadKey($privateKey, RSA::PRIVATE_FORMAT_PKCS1);
+        $rsa->loadKey($privateKey->getKey(), $privateKey->getType());
 
         return $rsa;
     }
 
     /**
      * Create RSA from public key.
      *
-     * @param string|array $publicKey
-     *
+     * @param Key $publicKey
      * @return RSAInterface
      */
-    public function createPublic($publicKey): RSAInterface
+    public function createPublic(Key $publicKey): RSAInterface
     {
-        $rsa = $this->create();
-        $rsa->loadKey($publicKey);
+        $rsa = $this->create($publicKey->getType());
+        $rsa->loadKey($publicKey->getKey());
         $rsa->setPublicKey();
 
         return $rsa;