Merge pull request #39 from robertlemke/http-basic-auth

[FEATURE] Support username / password for SaaS Elasticsearch

This change adds the two new client settings options "username" and
"password" which allows for setting credentials being integrated into
the request URL when accessing Elasticsearch instances protected by
HTTP Basic Auth.

Author: robertlemke

Classes/Flowpack/ElasticSearch/Domain/Model/Client/ClientConfiguration.php

@@ -33,6 +33,16 @@ class ClientConfiguration
      */
     protected $scheme = 'http';
 
+    /**
+     * @var string
+     */
+    protected $username = '';
+
+    /**
+     * @var string
+     */
+    protected $password = '';
+
     /**
      * @param string $host
      */
@@ -81,6 +91,48 @@ public function getScheme()
         return $this->scheme;
     }
 
+    /**
+     * Returns username
+     *
+     * @return string
+     */
+    public function getUsername()
+    {
+        return $this->username;
+    }
+
+    /**
+     * Sets username
+     *
+     * @param string $username
+     * @return void
+     */
+    public function setUsername($username)
+    {
+        $this->username = $username;
+    }
+
+    /**
+     * Returns password
+     *
+     * @return string
+     */
+    public function getPassword()
+    {
+        return $this->password;
+    }
+
+    /**
+     * Sets password
+     *
+     * @param string $password
+     * @return void
+     */
+    public function setPassword($password)
+    {
+        $this->password = $password;
+    }
+
     /**
      * @return \TYPO3\Flow\Http\Uri
      */
@@ -90,6 +142,8 @@ public function getUri()
         $uri->setScheme($this->scheme);
         $uri->setHost($this->host);
         $uri->setPort($this->port);
+        $uri->setUsername($this->username);
+        $uri->setPassword($this->password);
 
         return $uri;
     }

Classes/Flowpack/ElasticSearch/Transfer/RequestService.php

@@ -69,6 +69,12 @@ public function request($method, \Flowpack\ElasticSearch\Domain\Model\Client $cl
             $uri->setPath($uri->getPath() . $path);
         }
 
+        if ($uri->getUsername()) {
+            $requestEngine = $this->browser->getRequestEngine();
+            $requestEngine->setOption(CURLOPT_USERPWD, $uri->getUsername() . ':' . $uri->getPassword() );
+            $requestEngine->setOption(CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
+        }
+
         $response = $this->browser->request($uri, $method, $arguments, array(), array(),
             is_array($content) ? json_encode($content) : $content);
 

Configuration/Settings.yaml

@@ -5,6 +5,8 @@ Flowpack:
       default:
         - host: localhost
           port: 9200
+          username: ''
+          password: ''
 
     realtimeIndexing:
       enabled: TRUE

Documentation/Index.rst

@@ -33,6 +33,19 @@ have a dedicated server (recommended) for running the Functional Tests, set it u
 
 During runtime, you have to provide the client's name you want to connect to, if it is not `default`.
 
+When access to the Elasticsearch instance is protected through HTTP Basic Auth, you can provide the necessary username
+and password in your client settings::
+
+	Flowpack:
+	  ElasticSearch:
+	    clients:
+	        # default bundle that will be used if no more specific bundle name was supplied.
+	      default:
+	        - host: localhost
+	          port: 9200
+	          username: john
+	          password: mysecretpassword
+
 Running the Functional Tests
 ============================