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/Builders/CustomerCreditTransfer/CustomerCreditTransferBuilder.php

@@ -219,7 +219,7 @@ private function createCreditTransferTransactionElement(
             $xmlEndToEndId->nodeValue = $endToEndId;
         } else {
             $xmlEndToEndId->nodeValue = $this->randomService->uniqueIdWithDate(
-                'pete'.str_pad((string)$nbOfTxs, 2, '0')
+                'pete' . str_pad((string)$nbOfTxs, 2, '0')
             );
         }
         $xmlPmtId->appendChild($xmlEndToEndId);
@@ -246,7 +246,7 @@ private function createCreditTransferTransactionElement(
         //update PmtInf
         $nbOfTxsList = $xpath->query('//CstmrCdtTrfInitn/PmtInf/NbOfTxs');
         $xmlNbOfTxs = DOMHelper::safeItem($nbOfTxsList);
-        $xmlNbOfTxs->nodeValue = (string) $nbOfTxs;
+        $xmlNbOfTxs->nodeValue = (string)$nbOfTxs;
 
         $ctrlSumList = $xpath->query('//CstmrCdtTrfInitn/PmtInf/CtrlSum');
         $xmlCtrlSum = DOMHelper::safeItem($ctrlSumList);

src/Builders/CustomerDirectDebit/CustomerDirectDebitBuilder.php

@@ -252,7 +252,7 @@ public function addTransaction(
             $xmlEndToEndId->nodeValue = $endToEndId;
         } else {
             $xmlEndToEndId->nodeValue = $this->randomService->uniqueIdWithDate(
-                'pete'.str_pad((string)$nbOfTxs, 2, '0')
+                'pete' . str_pad((string)$nbOfTxs, 2, '0')
             );
         }
 

src/Contracts/Crypt/RSAInterface.php

@@ -13,7 +13,6 @@
  */
 interface RSAInterface
 {
-
     /**
      * @return BigIntegerInterface
      */
@@ -45,7 +44,7 @@ public function getModulus(): BigIntegerInterface;
      *
      * @return bool
      */
-    public function setPublicKey($key = false);
+    public function setPublicKey($key = false): bool;
 
     /**
      * Sets the password
@@ -57,7 +56,7 @@ public function setPublicKey($key = false);
      *
      * @return void
      */
-    public function setPassword($password = null);
+    public function setPassword($password = null): void;
 
     /**
      * Loads a public or private key
@@ -69,7 +68,7 @@ public function setPassword($password = null);
      *
      * @return bool
      */
-    public function loadKey($key, $type = false);
+    public function loadKey($key, $type = false): bool;
 
     /**
      * Decryption
@@ -78,7 +77,7 @@ public function loadKey($key, $type = false);
      *
      * @return string
      */
-    public function decrypt(string $ciphertext);
+    public function decrypt(string $ciphertext): string;
 
     /**
      * Encryption
@@ -91,7 +90,7 @@ public function decrypt(string $ciphertext);
      *
      * @return string
      */
-    public function encrypt(string $plaintext);
+    public function encrypt(string $plaintext): string;
 
     /**
      * Determines the public key format.
@@ -100,7 +99,7 @@ public function encrypt(string $plaintext);
      *
      * @return void
      */
-    public function setPublicKeyFormat(int $format);
+    public function setPublicKeyFormat(int $format): void;
 
     /**
      * Determines the private key format.
@@ -109,7 +108,7 @@ public function setPublicKeyFormat(int $format);
      *
      * @return void
      */
-    public function setPrivateKeyFormat(int $format);
+    public function setPrivateKeyFormat(int $format): void;
 
     /**
      * Determines which hashing function should be used.
@@ -121,7 +120,7 @@ public function setPrivateKeyFormat(int $format);
      *
      * @return void
      */
-    public function setHash(string $hash);
+    public function setHash(string $hash): void;
 
     /**
      * Determines which hashing function should be used for the mask generation function
@@ -133,7 +132,7 @@ public function setHash(string $hash);
      *
      * @return void
      */
-    public function setMGFHash($hash);
+    public function setMGFHash($hash): void;
 
     /**
      * Create public / private key pair.
@@ -158,7 +157,7 @@ public function createKey(int $bits = 1024, $timeout = false, array $partial = [
      *
      * @return string|null
      */
-    public function getPublicKey(int $type = RSA::PUBLIC_FORMAT_PKCS8);
+    public function getPublicKey(int $type = RSA::PUBLIC_FORMAT_PKCS8): ?string;
 
     /**
      * Returns the private key
@@ -167,9 +166,9 @@ public function getPublicKey(int $type = RSA::PUBLIC_FORMAT_PKCS8);
      *
      * @param int $type optional
      *
-     * @return mixed
+     * @return string|null
      */
-    public function getPrivateKey(int $type = RSA::PUBLIC_FORMAT_PKCS1);
+    public function getPrivateKey(int $type = RSA::PUBLIC_FORMAT_PKCS1): ?string;
 
     /**
      * Create a signature
@@ -178,7 +177,7 @@ public function getPrivateKey(int $type = RSA::PUBLIC_FORMAT_PKCS1);
      *
      * @return string|null
      */
-    public function sign(string $message);
+    public function sign(string $message): ?string;
 
     /**
      * Set Signature Mode
@@ -189,7 +188,7 @@ public function sign(string $message);
      *
      * @return void
      */
-    public function setSignatureMode($mode);
+    public function setSignatureMode($mode): void;
 
     /**
      * EMSA-PKCS1-V1_5-ENCODE
@@ -201,7 +200,7 @@ public function setSignatureMode($mode);
      *
      * @return string
      */
-    public function emsaPkcs1V15Encode($m, $emLen = null);
+    public function emsaPkcs1V15Encode($m, $emLen = null): string;
 
     /**
      * EMSA-PSS-ENCODE
@@ -213,7 +212,7 @@ public function emsaPkcs1V15Encode($m, $emLen = null);
      *
      * @return string
      */
-    public function emsaPssEncode($m, $emBits = null);
+    public function emsaPssEncode($m, $emBits = null): string;
 
     /**
      * EMSA-PSS-VERIFY
@@ -226,16 +225,16 @@ public function emsaPssEncode($m, $emBits = null);
      * @param int|null $emBits
      * @return bool
      */
-    public function emsaPssVerify($m, $em, $emBits = null);
+    public function emsaPssVerify($m, $em, $emBits = null): bool;
 
     /**
      * Change password for private key.
      *
-     * @param string $privateKey
+     * @param KeyPair $keyPair
      * @param string $oldPassword
      * @param string $newPassword
      *
      * @return KeyPair
      */
-    public function changePassword($privateKey, $oldPassword, $newPassword): KeyPair;
+    public function changePassword($keyPair, $oldPassword, $newPassword): KeyPair;
 }

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/KeyStorageLocatorInterface.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace EbicsApi\Ebics\Contracts;
+
+/**
+ * KeyStorageLocatorInterface.
+ *
+ * @license http://www.opensource.org/licenses/mit-license.html  MIT License
+ * @author Andrew Svirin
+ */
+interface KeyStorageLocatorInterface
+{
+    public const LOCATE_STRING = 'string';
+
+    /**
+     * Find appropriate key storage.
+     *
+     * @param mixed|string $value
+     *
+     * @return KeyStorageInterface
+     */
+    public function locate($value): KeyStorageInterface;
+
+    /**
+     * Get key storage.
+     *
+     * @param string $key
+     *
+     * @return KeyStorageInterface
+     */
+    public function get(string $key): KeyStorageInterface;
+}

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,8 @@
 use EbicsApi\Ebics\Services\BankLetter\Formatter\TxtBankLetterFormatter;
 use EbicsApi\Ebics\Services\BankLetterService;
 use EbicsApi\Ebics\Services\CryptService;
+use EbicsApi\Ebics\Services\KeyStorageLocator;
+use EbicsApi\Ebics\Services\RandomService;
 use LogicException;
 
 /**
@@ -33,9 +37,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(),