Update EDS logic. Update Timestamp format. Added SystemID support. Added Parameter to BTF. Added HAC order type. Fix Upload orders Digests.

andrew-svirin · andrew-svirin · commit 681df97c42ab · 2025-08-13T20:11:48.000+03:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -38,7 +38,7 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '7.4'
+          php-version: '8.1'
       - name: Composer Install
         run: composer install --no-scripts --no-progress --ansi
       - name: Run phpstan
@@ -60,7 +60,7 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '7.4'
+          php-version: '8.1'
       - name: Composer Install
         run: composer install --no-scripts --no-progress --ansi
       - name: Run phpcs
@@ -82,7 +82,7 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '7.4'
+          php-version: '8.1'
       - name: Composer Install
         run: composer install --no-scripts --no-progress --ansi
       - name: Prepare data
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,12 @@
 
 * Updated custom keyring details.
 * Dynamic Orders.
+* Updated EDS logic.
+* Updated `Timestamp` format.
+* Added `SystemID` support.
+* Added `Parameter` to BTF.
+* Added `HAC` order type.
+* Fix Upload orders Digest.
 
 ## 2.5
 
diff --git a/README.md b/README.md
@@ -157,7 +157,8 @@ try {
 | HKD         | Download customer's customer and subscriber information.                                             |
 | HTD         | Download subscriber's customer and subscriber information.                                           |
 | HAA         | Download Bank available order types.                                                                 |
-| PTK         | Download transaction status.                                                                         |
+| PTK         | Download transaction status (Plain text).                                                            |
+| HAC         | Download transaction status (XML).                                                                   |
 | FDL         | Download the files from the bank.                                                                    |
 | FUL         | Upload the files to the bank.                                                                        |
 | BTD         | Download request files of any BTF structure.                                                         |
diff --git a/composer.json b/composer.json
@@ -21,7 +21,7 @@
   ],
   "license": "MIT",
   "require": {
-    "php": "^7.4 || ^8",
+    "php": "^8.1",
     "ext-bcmath": "*",
     "ext-curl": "*",
     "ext-dom": "*",
@@ -34,13 +34,13 @@
   "require-dev": {
     "ebics-api/cfonb-php": "^1.0",
     "ebics-api/mt942-php": "^1.0",
-    "phpseclib/phpseclib": "~2.0.35",
-    "phpstan/phpstan": "~1.9.17",
-    "phpunit/phpunit": "~9.6.3",
+    "phpseclib/phpseclib": "~2.0.48",
+    "phpstan/phpstan": "~1.9.18",
+    "phpunit/phpunit": "~9.6.24",
     "psr/http-client": "^1.0",
     "psr/http-factory": "^1.0",
     "setasign/fpdf": "^1.8",
-    "squizlabs/php_codesniffer": "~3.7.1"
+    "squizlabs/php_codesniffer": "~3.7.2"
   },
   "autoload": {
     "psr-4": {
diff --git a/src/Builders/Request/DataEncryptionInfoBuilder.php b/src/Builders/Request/DataEncryptionInfoBuilder.php
@@ -51,7 +51,15 @@ public function addEncryptionPubKeyDigest(Keyring $keyring, string $algorithm =
         if (!($signatureE = $keyring->getBankSignatureE())) {
             throw new SignatureEbicsException('Bank Certificate E is empty.');
         }
-        $certificateEDigest = $this->cryptService->calculateDigest($signatureE, $algorithm);
+
+        if ($signatureE->getCertificateContent()) {
+            $certificateEDigest = $this->cryptService->calculateCertificateFingerprint(
+                $signatureE->getCertificateContent(),
+                $algorithm
+            );
+        } else {
+            $certificateEDigest = $this->cryptService->calculatePublicKeyDigest($signatureE, $algorithm);
+        }
         $encryptionPubKeyDigestNodeValue = base64_encode($certificateEDigest);
 
         $this->appendElementTo('EncryptionPubKeyDigest', $encryptionPubKeyDigestNodeValue, $this->instance, [
diff --git a/src/Builders/Request/StaticBuilder.php b/src/Builders/Request/StaticBuilder.php
@@ -51,7 +51,11 @@ public function addRandomNonce(): StaticBuilder
 
     public function addTimestamp(DateTimeInterface $dateTime): StaticBuilder
     {
-        $this->appendElementTo('Timestamp', $dateTime->format('Y-m-d\TH:i:s\Z'), $this->instance);
+        $milliseconds = (int)($dateTime->format('u') / 1000);
+
+        $formatted = $dateTime->format('Y-m-d\TH:i:s') . sprintf('.%03dZ', $milliseconds);
+
+        $this->appendElementTo('Timestamp', $formatted, $this->instance);
 
         return $this;
     }
@@ -70,6 +74,13 @@ public function addUserId(string $userId): StaticBuilder
         return $this;
     }
 
+    public function addSystemId(string $systemId): StaticBuilder
+    {
+        $this->appendElementTo('SystemID', $systemId, $this->instance);
+
+        return $this;
+    }
+
     public function addProduct(string $product, string $language): StaticBuilder
     {
         $this->appendElementTo('Product', $product, $this->instance, ['Language' => $language]);
diff --git a/src/Contexts/BTFContext.php b/src/Contexts/BTFContext.php
@@ -10,30 +10,17 @@
  */
 abstract class BTFContext extends ServiceContext
 {
-    private bool $signatureFlag = false;
-    private bool $signatureFlagEds = false;
+    private array $parameters = [];
 
-    public function setSignatureFlag(bool $signatureFlag): self
+    public function setParameter(string $name, string $value): self
     {
-        $this->signatureFlag = $signatureFlag;
+        $this->parameters[$name] = $value;
 
         return $this;
     }
 
-    public function getSignatureFlag(): bool
+    public function getParameters(): array
     {
-        return $this->signatureFlag;
-    }
-
-    public function setSignatureFlagEds(bool $signatureFlagEds): self
-    {
-        $this->signatureFlagEds = $signatureFlagEds;
-
-        return $this;
-    }
-
-    public function getSignatureFlagEds(): bool
-    {
-        return $this->signatureFlagEds;
+        return $this->parameters;
     }
 }
diff --git a/src/Handlers/OrderDataHandler.php b/src/Handlers/OrderDataHandler.php
@@ -148,8 +148,8 @@ abstract public function retrieveAuthenticationSignature(XmlDocument $document):
      */
     abstract public function retrieveEncryptionSignature(XmlDocument $document): SignatureInterface;
 
-    public function hash(XmlData $xml): string
+    public function hash(string $content): string
     {
-        return $this->cryptService->hash($xml->getContent());
+        return $this->cryptService->hash($content);
     }
 }
diff --git a/src/Orders/BTD.php b/src/Orders/BTD.php
@@ -168,5 +168,7 @@ private function addBTDOrderParams(
             );
             $xmlBTDOrderParams->appendChild($xmlDateRange);
         }
+
+        $orderDetailsBuilder->addParameters($xmlBTDOrderParams, $this->btdContext->getParameters());
     }
 }
diff --git a/src/Orders/BTU.php b/src/Orders/BTU.php
@@ -59,9 +59,7 @@ private function buildRequest(): Request
         $this->userSignatureHandler->handle($signatureData, $this->transaction->getDigest());
 
         $signatureVersion = $this->context->getKeyring()->getUserSignatureAVersion();
-        $dataDigest = $this->requestFactory->userSignA(
-            $this->transaction->getDigest()
-        );
+        $dataDigest = $this->orderDataHandler->hash($this->orderData->getContent());
 
         $this->context
             ->setOrderType('BTU')
@@ -117,11 +115,7 @@ private function buildRequest(): Request
                                     );
                             })
                             ->addSignatureData($this->context->getSignatureData(), $this->context->getTransactionKey())
-                            ->addDataDigest(
-                                $this->context->getSignatureVersion(),
-                                $this->context->getDataDigest()
-                            )
-                            ->addAdditionalOrderInfo();
+                            ->addDataDigest($this->context->getSignatureVersion(), $this->context->getDataDigest());
                     });
                 });
             })
@@ -164,12 +158,12 @@ private function addBTUOrderParams(OrderDetailsBuilder $orderDetailsBuilder): vo
             $xmlMsgName->setAttribute('format', $this->btuContext->getMsgNameFormat());
         }
 
-        if (true === $this->btuContext->getSignatureFlag()) {
+        if ($this->context->getWithES()) {
             $xmlSignatureFlag = $orderDetailsBuilder->appendEmptyElementTo('SignatureFlag', $xmlBTUOrderParams);
 
-            if (true === $this->btuContext->getSignatureFlagEds()) {
-                $xmlSignatureFlag->setAttribute('requestEDS', 'true');
-            }
+            $xmlSignatureFlag->setAttribute('requestEDS', 'true');
         }
+
+        $orderDetailsBuilder->addParameters($xmlBTUOrderParams, $this->btuContext->getParameters());
     }
 }
diff --git a/src/Orders/H3K.php b/src/Orders/H3K.php
@@ -57,7 +57,7 @@ private function buildRequest(): Request
         $signatureData = new UserSignature();
         $this->userSignatureHandler->handle(
             $signatureData,
-            $this->orderDataHandler->hash($orderData)
+            $this->orderDataHandler->hash($orderData->getContent())
         );
 
         $this->context
diff --git a/src/Orders/HAC.php b/src/Orders/HAC.php
@@ -0,0 +1,104 @@
+<?php
+
+namespace EbicsApi\Ebics\Orders;
+
+use DateTimeInterface;
+use EbicsApi\Ebics\Builders\Request\HeaderBuilder;
+use EbicsApi\Ebics\Builders\Request\MutableBuilder;
+use EbicsApi\Ebics\Builders\Request\OrderDetailsBuilder;
+use EbicsApi\Ebics\Builders\Request\RootBuilder;
+use EbicsApi\Ebics\Builders\Request\StaticBuilder;
+use EbicsApi\Ebics\Contexts\RequestContext;
+use EbicsApi\Ebics\Contracts\EbicsClientInterface;
+use EbicsApi\Ebics\Exceptions\MethodNotImplemented;
+use EbicsApi\Ebics\Models\Http\Request;
+use EbicsApi\Ebics\Models\Keyring;
+use EbicsApi\Ebics\Models\Order\DownloadOrder;
+
+/**
+ * Download transaction status (XML).
+ *
+ * @license http://www.opensource.org/licenses/mit-license.html  MIT License
+ * @author Andrew Svirin
+ */
+final class HAC extends DownloadOrder
+{
+    private ?DateTimeInterface $startDateTime;
+
+    private ?DateTimeInterface $endDateTime;
+
+    public function __construct(
+        ?DateTimeInterface $startDateTime = null,
+        ?DateTimeInterface $endDateTime = null,
+        ?RequestContext $context = null
+    ) {
+        $this->startDateTime = $startDateTime;
+        $this->endDateTime = $endDateTime;
+        $this->context = $context;
+    }
+
+    public function prepareContext(): void
+    {
+        parent::prepareContext();
+        $this->context
+            ->setStartDateTime($this->startDateTime)
+            ->setEndDateTime($this->endDateTime);
+    }
+
+    public function createRequest(): Request
+    {
+        return $this->buildRequest();
+    }
+
+    public function getParserFormat(): string
+    {
+        return EbicsClientInterface::FILE_PARSER_FORMAT_TEXT;
+    }
+
+    private function buildRequest(): Request
+    {
+        $this->context
+            ->setOrderType('HAC');
+
+        return $this
+            ->requestFactory->createRequestBuilderInstance()
+            ->addContainerSecured(function (RootBuilder $builder) {
+                $builder->addHeader(function (HeaderBuilder $builder) {
+                    $builder->addStatic(function (StaticBuilder $builder) {
+                        $builder
+                            ->addHostId($this->context->getBank()->getHostId())
+                            ->addRandomNonce()
+                            ->addTimestamp($this->context->getDateTime())
+                            ->addPartnerId($this->context->getUser()->getPartnerId())
+                            ->addUserId($this->context->getUser()->getUserId())
+                            ->addProduct($this->context->getProduct(), $this->context->getLanguage())
+                            ->addOrderDetails(function (OrderDetailsBuilder $orderDetailsBuilder) {
+                                $this->requestFactory
+                                    ->addOrderType(
+                                        $orderDetailsBuilder,
+                                        $this->context->getOrderType(),
+                                        $this->context->getWithES() ?
+                                            OrderDetailsBuilder::ORDER_ATTRIBUTE_OZHNN :
+                                            OrderDetailsBuilder::ORDER_ATTRIBUTE_DZHNN
+                                    )
+                                    ->addStandardOrderParams(
+                                        $this->context->getStartDateTime(),
+                                        $this->context->getEndDateTime()
+                                    );
+                            })
+                            ->addBankPubKeyDigests(
+                                $this->context->getKeyring()->getBankSignatureXVersion(),
+                                $this->requestFactory->signDigest($this->context->getKeyring()->getBankSignatureX()),
+                                $this->context->getKeyring()->getBankSignatureEVersion(),
+                                $this->requestFactory->signDigest($this->context->getKeyring()->getBankSignatureE())
+                            )
+                            ->addSecurityMedium(StaticBuilder::SECURITY_MEDIUM_0000);
+                    })->addMutable(function (MutableBuilder $builder) {
+                        $builder
+                            ->addTransactionPhase(MutableBuilder::PHASE_INITIALIZATION);
+                    });
+                })->addBody();
+            })
+            ->popInstance();
+    }
+}
diff --git a/src/Orders/HCS.php b/src/Orders/HCS.php
@@ -61,12 +61,17 @@ private function buildRequest(): Request
         $signatureData = new UserSignature();
         $this->userSignatureHandler->handle($signatureData, $this->transaction->getDigest());
 
+        $signatureVersion = $this->context->getKeyring()->getUserSignatureAVersion();
+        $dataDigest = $this->orderDataHandler->hash($this->orderData->getContent());
+
         $this->context
             ->setOrderType('HCS')
             ->setWithES(true)
             ->setTransactionKey($this->transaction->getKey())
             ->setNumSegments($this->transaction->getNumSegments())
-            ->setSignatureData($signatureData);
+            ->setSignatureData($signatureData)
+            ->setSignatureVersion($signatureVersion)
+            ->setDataDigest($dataDigest);
 
         return $this->requestFactory
             ->createRequestBuilderInstance()
@@ -114,7 +119,7 @@ private function buildRequest(): Request
                                     );
                             })
                             ->addSignatureData($this->context->getSignatureData(), $this->context->getTransactionKey())
-                            ->addDataDigest($this->context->getKeyring()->getUserSignatureAVersion());
+                            ->addDataDigest($this->context->getSignatureVersion(), $this->context->getDataDigest());
                     });
                 });
             })
diff --git a/src/Orders/PTK.php b/src/Orders/PTK.php
@@ -10,13 +10,11 @@
 use EbicsApi\Ebics\Builders\Request\StaticBuilder;
 use EbicsApi\Ebics\Contexts\RequestContext;
 use EbicsApi\Ebics\Contracts\EbicsClientInterface;
-use EbicsApi\Ebics\Exceptions\MethodNotImplemented;
 use EbicsApi\Ebics\Models\Http\Request;
-use EbicsApi\Ebics\Models\Keyring;
 use EbicsApi\Ebics\Models\Order\DownloadOrder;
 
 /**
- * Download transaction status.
+ * Download transaction status (Plain text).
  *
  * @license http://www.opensource.org/licenses/mit-license.html  MIT License
  * @author Andrew Svirin
diff --git a/src/Orders/SPR.php b/src/Orders/SPR.php
diff --git a/src/Services/CryptService.php b/src/Services/CryptService.php
diff --git a/src/Services/DigestResolverV2.php b/src/Services/DigestResolverV2.php
diff --git a/tests/EbicsClientV25Test.php b/tests/EbicsClientV25Test.php
diff --git a/tests/EbicsClientV30Test.php b/tests/EbicsClientV30Test.php

Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,11 @@ public function addRandomNonce(): StaticBuilder`
`51`	`51`
`52`	`52`	`public function addTimestamp(DateTimeInterface $dateTime): StaticBuilder`
`53`	`53`	`{`
`54`		`- $this->appendElementTo('Timestamp', $dateTime->format('Y-m-d\TH:i:s\Z'), $this->instance);`
	`54`	`+ $milliseconds = (int)($dateTime->format('u') / 1000);`
	`55`	`+`
	`56`	`+ $formatted = $dateTime->format('Y-m-d\TH:i:s') . sprintf('.%03dZ', $milliseconds);`
	`57`	`+`
	`58`	`+ $this->appendElementTo('Timestamp', $formatted, $this->instance);`
`55`	`59`
`56`	`60`	`return $this;`
`57`	`61`	`}`
`@@ -70,6 +74,13 @@ public function addUserId(string $userId): StaticBuilder`
`70`	`74`	`return $this;`
`71`	`75`	`}`
`72`	`76`
	`77`	`+ public function addSystemId(string $systemId): StaticBuilder`
	`78`	`+ {`
	`79`	`+ $this->appendElementTo('SystemID', $systemId, $this->instance);`
	`80`	`+`
	`81`	`+ return $this;`
	`82`	`+ }`
	`83`	`+`
`73`	`84`	`public function addProduct(string $product, string $language): StaticBuilder`
`74`	`85`	`{`
`75`	`86`	`$this->appendElementTo('Product', $product, $this->instance, ['Language' => $language]);`
Original file line number	Diff line number	Diff line change
`@@ -10,30 +10,17 @@`
`10`	`10`	`*/`
`11`	`11`	`abstract class BTFContext extends ServiceContext`
`12`	`12`	`{`
`13`		`- private bool $signatureFlag = false;`
`14`		`- private bool $signatureFlagEds = false;`
	`13`	`+ private array $parameters = [];`
`15`	`14`
`16`		`- public function setSignatureFlag(bool $signatureFlag): self`
	`15`	`+ public function setParameter(string $name, string $value): self`
`17`	`16`	`{`
`18`		`- $this->signatureFlag = $signatureFlag;`
	`17`	`+ $this->parameters[$name] = $value;`
`19`	`18`
`20`	`19`	`return $this;`
`21`	`20`	`}`
`22`	`21`
`23`		`- public function getSignatureFlag(): bool`
	`22`	`+ public function getParameters(): array`
`24`	`23`	`{`
`25`		`- return $this->signatureFlag;`
`26`		`- }`
`27`		`-`
`28`		`- public function setSignatureFlagEds(bool $signatureFlagEds): self`
`29`		`- {`
`30`		`- $this->signatureFlagEds = $signatureFlagEds;`
`31`		`-`
`32`		`- return $this;`
`33`		`- }`
`34`		`-`
`35`		`- public function getSignatureFlagEds(): bool`
`36`		`- {`
`37`		`- return $this->signatureFlagEds;`
	`24`	`+ return $this->parameters;`
`38`	`25`	`}`
`39`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -148,8 +148,8 @@ abstract public function retrieveAuthenticationSignature(XmlDocument $document):`
`148`	`148`	`*/`
`149`	`149`	`abstract public function retrieveEncryptionSignature(XmlDocument $document): SignatureInterface;`
`150`	`150`
`151`		`- public function hash(XmlData $xml): string`
	`151`	`+ public function hash(string $content): string`
`152`	`152`	`{`
`153`		`- return $this->cryptService->hash($xml->getContent());`
	`153`	`+ return $this->cryptService->hash($content);`
`154`	`154`	`}`
`155`	`155`	`}`
Original file line number	Diff line number	Diff line change
`@@ -168,5 +168,7 @@ private function addBTDOrderParams(`
`168`	`168`	`);`
`169`	`169`	`$xmlBTDOrderParams->appendChild($xmlDateRange);`
`170`	`170`	`}`
	`171`	`+`
	`172`	`+ $orderDetailsBuilder->addParameters($xmlBTDOrderParams, $this->btdContext->getParameters());`
`171`	`173`	`}`
`172`	`174`	`}`