Merge pull request #4 from dreamfactorysoftware/wsse-update

Update WsseAuthHeader class

Author: Taras Viyatyk

database/migrations/2019_07_10_091600_create_soap_wsse_username_token_field.php

@@ -0,0 +1,42 @@
+<?php
+
+use Illuminate\Support\Facades\Schema;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Database\Migrations\Migration;
+
+class CreateSoapWsseUsernameTokenField extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        if (!Schema::hasColumn('soap_config', 'wsse_username_token')) {
+            Schema::table(
+                'soap_config',
+                function (Blueprint $t){
+                    $t->string('wsse_username_token')->default(0)->nullable();
+                }
+            );
+        }
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        if (Schema::hasColumn('soap_config', 'wsse_username_token')) {
+            Schema::table(
+                'soap_config',
+                function (Blueprint $t){
+                    $t->dropColumn('wsse_username_token');
+                }
+            );
+        }
+    }
+}

src/Components/WsseAuthHeader.php

@@ -7,29 +7,35 @@
 
 class WsseAuthHeader extends SoapHeader
 {
+    // Namespaces
+    private $ns_wsse = 'http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd';
+    private $ns_wsu = 'http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd';
+    private $password_type = 'http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordDigest';
+    private $encoding_type = 'http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary';
 
-    private $wss_ns = 'http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd';
-    private $wsu_ns = 'http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd';
-
-    function __construct($user, $pass)
+    function __construct($username, $password, $wsse_username_token = null)
     {
-        $created = gmdate('Y-m-d\TH:i:s\Z');
-        $nonce = mt_rand();
-        $passdigest = base64_encode(pack('H*', sha1(pack('H*', $nonce) . pack('a*', $created) . pack('a*', $pass))));
-
-        $auth = new \stdClass();
-        $auth->Username = new SoapVar($user, XSD_STRING, null, $this->wss_ns, null, $this->wss_ns);
-        $auth->Password = new SoapVar($pass, XSD_STRING, null, $this->wss_ns, null, $this->wss_ns);
-        $auth->Nonce = new SoapVar($passdigest, XSD_STRING, null, $this->wss_ns, null, $this->wss_ns);
-        $auth->Created = new SoapVar($created, XSD_STRING, null, $this->wss_ns, null, $this->wsu_ns);
-
-        $username_token = new \stdClass();
-        $username_token->UsernameToken =
-            new SoapVar($auth, SOAP_ENC_OBJECT, null, $this->wss_ns, 'UsernameToken', $this->wss_ns);
-
-        $security_sv = new SoapVar(
-            new SoapVar($username_token, SOAP_ENC_OBJECT, null, $this->wss_ns, 'UsernameToken', $this->wss_ns),
-            SOAP_ENC_OBJECT, null, $this->wss_ns, 'Security', $this->wss_ns);
-        parent::__construct($this->wss_ns, 'Security', $security_sv, true);
+        $simple_nonce = mt_rand();
+        $created_at = gmdate('Y-m-d\TH:i:s\Z');
+        $encoded_nonce = base64_encode($simple_nonce);
+        $password_digest = base64_encode(sha1($simple_nonce . $created_at . $password, true));
+
+        // Creating WSS identification header using SimpleXML
+        $root = new \SimpleXMLElement('<root/>');
+        $security = $root->addChild('wsse:Security', null, $this->ns_wsse);
+        $usernameToken = $security->addChild('wsse:UsernameToken', null, $this->ns_wsse);
+        if($wsse_username_token){
+            $usernameToken->addAttribute('wsu:Id', $wsse_username_token, $this->ns_wsu);
+        }
+        $usernameToken->addChild('Username', $username, $this->ns_wsse);
+        $usernameToken->addChild('Password', $password_digest, $this->ns_wsse)->addAttribute('Type', $this->password_type);
+        $usernameToken->addChild('Nonce', $encoded_nonce, $this->ns_wsse)->addAttribute('EncodingType', $this->encoding_type);
+        $usernameToken->addChild('Created', $created_at, $this->ns_wsu);
+
+        // Recovering XML value from that object
+        $root->registerXPathNamespace('wsse', $this->ns_wsse);
+        $full = $root->xpath('/root/wsse:Security');
+        $auth = $full[0]->asXML();
+        parent::__construct($this->ns_wsse, 'Security', new SoapVar($auth, XSD_ANYXML), true);
     }
 }

src/Models/SoapConfig.php

@@ -11,7 +11,7 @@ class SoapConfig extends BaseServiceConfigModel
 
     protected $table = 'soap_config';
 
-    protected $fillable = ['service_id', 'wsdl', 'options', 'headers'];
+    protected $fillable = ['service_id', 'wsdl', 'options', 'headers', 'wsse_username_token'];
 
     protected $casts = ['options' => 'array', 'headers' => 'array'];
 
@@ -87,7 +87,14 @@ protected static function prepareConfigSchemaField(array &$schema)
                 ];
                 $schema['description'] =
                     'An array of headers for the connection. ' .
-                    'For further info, see http://php.net/manual/en/class.soapheader.php.';
+                    'For further info, see http://php.net/manual/en/class.soapheader.php. ' .
+                    'TIP: Select type "WSSE" and write "password", "username" into ' . 
+                    'Name field if you want pass username and password into WSSE header.';
+                break;
+            case 'wsse_username_token':
+            $schema['label'] = 'WSSE Username Token';
+                $schema['default'] = null;
+                $schema['description'] = 'WSSE Username Token';
                 break;
         }
     }

src/Services/Soap.php

@@ -123,20 +123,24 @@ public function __construct($settings)
 //            }
 
             $headers = array_get($config, 'headers');
+            $wsseUsernameToken = array_get($config, 'wsse_username_token');
             $soapHeaders = null;
 
             if (!empty($headers)) {
                 foreach ($headers as $header) {
                     $headerType = array_get($header, 'type', 'generic');
                     switch ($headerType) {
                         case 'wsse':
-                            $data = json_decode(stripslashes(array_get($header, 'data', '{}')), true);
-                            $data = (is_null($data) || !is_array($data)) ? [] : $data;
-                            $username = array_get($data, 'username');
-                            $password = array_get($data, 'password');
+                            $data = (is_null($header) || !is_array($header)) ? [] : $header;
+
+                            if (array_get($data, 'name') == 'username'){
+                                $username = array_get($data, 'data');
+                            } elseif (array_get($data, 'name') == 'password'){
+                                $password = array_get($data, 'data');
+                            }
 
                             if (!empty($username) && !empty($password)) {
-                                $soapHeaders[] = new WsseAuthHeader($username, $password);
+                                    $soapHeaders[] = new WsseAuthHeader($username, $password, $wsseUsernameToken);
                             }
 
                             break;