MAC_ADVANCED / MAC_EXTENDED switch methods!

veneliniliev · Apr 2, 2021 · 9c2ac2d · 9c2ac2d
1 parent 43c384d
commit 9c2ac2d
Show file tree

Hide file tree

Showing 5 changed files with 184 additions and 91 deletions.
diff --git a/README.md b/README.md
@@ -47,6 +47,13 @@ openssl req -new -key development.key -out VNNNNNNN_YYYYMMDD_D.csr
 
 ## Usage
 
+**IMPORTANT**: Switch signing schema MAC_EXTENDED / MAC_ADVANCED with methods:
+````php
+$saleRequest->setSigningSchemaMacExtended(); // use MAC_EXTENDED
+$saleRequest->setSigningSchemaMacAdvanced(); // use MAC_ADVANCED
+````
+Default signing schema is **MAC_ADVANCED**!
+
 ### Sale request
 
 ````php
@@ -61,6 +68,8 @@ $saleRequest = (new SaleRequest())
     ->setTerminalID('<TID - V*******>')
     ->setMerchantId('<MID - 15 chars>')
     ->setPrivateKey('\<path to certificate.key>', '<password / or use method from bottom>')
+    //->setSigningSchemaMacExtended(); // use MAC_EXTENDED
+    //->setSigningSchemaMacAdvanced(); // use MAC_ADVANCED
     ->setPrivateKeyPassword('test');
 
 $formHtml = $saleRequest->generateForm(); // only generate hidden html form with filled inputs 

diff --git a/src/Base.php b/src/Base.php
@@ -14,11 +14,26 @@
 abstract class Base
 {
 
+    const SIGNING_SCHEMA_MAC_ADVANCED = 'MAC_ADVANCED';
+    const SIGNING_SCHEMA_MAC_EXTENDED = 'MAC_EXTENDED';
+
+    /**
+     * Default signing schema
+     *
+     * @var string
+     */
+    protected $signingSchema = self::SIGNING_SCHEMA_MAC_ADVANCED;
+
     /**
      * @var string
      */
     protected $merchantId;
 
+    /**
+     * @var string
+     */
+    protected $publicKey;
+
     /**
      * @var string
      */
@@ -44,15 +59,11 @@ abstract class Base
 
     /**
      * In develop mode of application
+     *
      * @var string
      */
     private $environment = 'production';
 
-    /**
-     * @var string
-     */
-    protected $publicKey;
-
     /**
      * @return boolean
      */
@@ -82,6 +93,7 @@ public function getEnvironmentUrl()
 
     /**
      * Switch environment to development/production
+     *
      * @param boolean $production True - production / false - development.
      *
      * @return Base
@@ -98,6 +110,7 @@ public function setEnvironment($production = true)
 
     /**
      * Switch to production mode
+     *
      * @return Base
      */
     public function inProduction()
@@ -108,6 +121,7 @@ public function inProduction()
 
     /**
      * Switch to development mode
+     *
      * @return Base
      */
     public function inDevelopment()
@@ -118,6 +132,7 @@ public function inDevelopment()
 
     /**
      * Get terminal ID
+     *
      * @return mixed
      */
     public function getTerminalID()
@@ -127,7 +142,9 @@ public function getTerminalID()
 
     /**
      * Set terminal ID
+     *
      * @param string $terminalID Terminal ID.
+     *
      * @return Base
      * @throws ParameterValidationException
      */
@@ -167,9 +184,71 @@ public function setMerchantId($merchantId)
         return $this;
     }
 
+    /**
+     * Switch signing schema to MAC_ADVANCED
+     *
+     * @return Base
+     */
+    public function setSigningSchemaMacAdvanced()
+    {
+        $this->signingSchema = self::SIGNING_SCHEMA_MAC_ADVANCED;
+        return $this;
+    }
+
+    /**
+     * Switch signing schema to MAC_EXTENDED
+     *
+     * @return Base
+     */
+    public function setSigningSchemaMacExtended()
+    {
+        $this->signingSchema = self::SIGNING_SCHEMA_MAC_EXTENDED;
+        return $this;
+    }
+
+    /**
+     * Get public key
+     *
+     * @return string
+     * @throws ParameterValidationException
+     */
+    public function getPublicKey()
+    {
+        if (empty($this->publicKey)) {
+            throw new ParameterValidationException('Please set public key first!');
+        }
+
+        return $this->publicKey;
+    }
+
+    /**
+     * Set public key
+     *
+     * @param string $publicKey Public key path.
+     *
+     * @return Base
+     */
+    public function setPublicKey($publicKey)
+    {
+        $this->publicKey = $publicKey;
+        return $this;
+    }
+
+    /**
+     * Is MAC_ADVANCE signing schema?
+     *
+     * @return boolean
+     */
+    protected function isSigningSchemaMacAdvanced()
+    {
+        return $this->signingSchema == self::SIGNING_SCHEMA_MAC_ADVANCED;
+    }
+
     /**
      * Generate signature of data with private key
+     *
      * @param array $data Данни върху които да генерира подписа.
+     *
      * @return string
      * @throws SignatureException
      */
@@ -193,10 +272,10 @@ protected function getPrivateSignature(array $data)
         if (PHP_MAJOR_VERSION < 8) {
             /**
              * @deprecated in PHP 8.0
-             * @note The openssl_pkey_free() function is deprecated and no longer has an effect,
+             * @note       The openssl_pkey_free() function is deprecated and no longer has an effect,
              * instead the OpenSSLAsymmetricKey instance is automatically destroyed if it is no
              * longer referenced.
-             * @see https://github.com/php/php-src/blob/master/UPGRADING#L397
+             * @see        https://github.com/php/php-src/blob/master/UPGRADING#L397
              */
             openssl_pkey_free($privateKey);
         }
@@ -206,8 +285,10 @@ protected function getPrivateSignature(array $data)
 
     /**
      * Generate signature source
+     *
      * @param array   $data       Data of signature.
      * @param boolean $isResponse Generate signature from response.
+     *
      * @return string
      */
     protected function getSignatureSource(array $data, $isResponse = false)
@@ -225,6 +306,7 @@ protected function getSignatureSource(array $data, $isResponse = false)
 
     /**
      * Get private key
+     *
      * @return string
      */
     public function getPrivateKey()
@@ -234,8 +316,10 @@ public function getPrivateKey()
 
     /**
      * Set private key
+     *
      * @param string      $privateKeyPath Път до файла на частният ключ.
      * @param string|null $password       Парола на частният ключ.
+     *
      * @return Base
      */
     public function setPrivateKey($privateKeyPath, $password = null)
@@ -251,6 +335,7 @@ public function setPrivateKey($privateKeyPath, $password = null)
 
     /**
      * Get private key password
+     *
      * @return string|null
      */
     public function getPrivateKeyPassword()
@@ -260,40 +345,14 @@ public function getPrivateKeyPassword()
 
     /**
      * Set private key password
+     *
      * @param string|null $privateKeyPassword Парола на частният ключ.
+     *
      * @return Base
      */
     public function setPrivateKeyPassword($privateKeyPassword)
     {
         $this->privateKeyPassword = $privateKeyPassword;
         return $this;
     }
-
-    /**
-     * Get public key
-     *
-     * @return string
-     * @throws ParameterValidationException
-     */
-    public function getPublicKey()
-    {
-        if (empty($this->publicKey)) {
-            throw new ParameterValidationException('Please set public key first!');
-        }
-
-        return $this->publicKey;
-    }
-
-    /**
-     * Set public key
-     *
-     * @param string $publicKey Public key path.
-     *
-     * @return Base
-     */
-    public function setPublicKey($publicKey)
-    {
-        $this->publicKey = $publicKey;
-        return $this;
-    }
 }