close #47 support connection with API key

Author: stephanediondev

.env.dist

@@ -33,6 +33,7 @@ INSTALLATION_TYPE=source
 ELASTICSEARCH_URL=http://localhost:9200
 ELASTICSEARCH_USERNAME=
 ELASTICSEARCH_PASSWORD=
+ELASTICSEARCH_API_KEY=
 SSL_VERIFY_PEER=true
 SSL_VERIFY_HOST=true
 SECRET_REGISTER=

Dockerfile

@@ -8,6 +8,7 @@ ENV INSTALLATION_TYPE=docker
 ENV ELASTICSEARCH_URL=$ELASTICSEARCH_URL
 ENV ELASTICSEARCH_USERNAME=$ELASTICSEARCH_USERNAME
 ENV ELASTICSEARCH_PASSWORD=$ELASTICSEARCH_PASSWORD
+ENV ELASTICSEARCH_API_KEY=$ELASTICSEARCH_API_KEY
 ENV SSL_VERIFY_PEER=$SSL_VERIFY_PEER
 ENV SSL_VERIFY_HOST=$SSL_VERIFY_HOST
 

config/services.yaml

@@ -17,6 +17,7 @@ services:
             $elasticsearchUrl: '%env(ELASTICSEARCH_URL)%'
             $elasticsearchUsername: '%env(ELASTICSEARCH_USERNAME)%'
             $elasticsearchPassword: '%env(ELASTICSEARCH_PASSWORD)%'
+            $elasticsearchApiKey: '%env(ELASTICSEARCH_API_KEY)%'
             $sslVerifyPeer: '%env(bool:SSL_VERIFY_PEER)%'
             $sslVerifyHost: '%env(bool:SSL_VERIFY_HOST)%'
             $secretRegister: '%env(SECRET_REGISTER)%'

docs/docker-for-development.md

@@ -77,11 +77,12 @@ echo 'path.repo: ["/usr/share/elasticsearch/fs"]' >> config/elasticsearch.yml
 docker pull stephanediondev/elasticsearch-admin
 docker stop elasticsearch-admin && docker rm elasticsearch-admin && docker rmi elasticsearch-admin
 docker run -e "ELASTICSEARCH_URL=http://x.x.x.x:9200" -e "SECRET_REGISTER=xxxxx" -p 80:8080 -d --name elasticsearch-admin stephanediondev/elasticsearch-admin
-
-# Edit ELASTICSEARCH_URL and SECRET_REGISTER (random string to secure registration)
-# If Elasticsearch security features are enabled, add -e "ELASTICSEARCH_USERNAME=xxxxx" -e "ELASTICSEARCH_PASSWORD=xxxxx"
 ```
 
+Edit ```ELASTICSEARCH_URL``` and ```SECRET_REGISTER``` (random string to secure registration)
+
+If Elasticsearch security features are enabled, add ```-e "ELASTICSEARCH_USERNAME=xxxxx" -e "ELASTICSEARCH_PASSWORD=xxxxx"``` or ```-e "ELASTICSEARCH_API_KEY=xxxxx"```
+
 ### Build and run elasticsearch-admin with source installation
 
 ````
@@ -90,11 +91,12 @@ docker stop elasticsearch-admin && docker rm elasticsearch-admin && docker rmi e
 docker build --force-rm --tag elasticsearch-admin .
 
 docker run -e "ELASTICSEARCH_URL=http://x.x.x.x:9200" -e "SECRET_REGISTER=xxxxx" -p 80:8080 -d --name elasticsearch-admin elasticsearch-admin
-
-# Edit ELASTICSEARCH_URL and SECRET_REGISTER (random string to secure registration)
-# If Elasticsearch security features are enabled, add -e "ELASTICSEARCH_USERNAME=xxxxx" -e "ELASTICSEARCH_PASSWORD=xxxxx"
 ````
 
+Edit ```ELASTICSEARCH_URL``` and ```SECRET_REGISTER``` (random string to secure registration)
+
+If Elasticsearch security features are enabled, add ```-e "ELASTICSEARCH_USERNAME=xxxxx" -e "ELASTICSEARCH_PASSWORD=xxxxx"``` or ```-e "ELASTICSEARCH_API_KEY=xxxxx"```
+
 ### /etc/hosts
 
 ```
@@ -136,6 +138,7 @@ docker run -e "ELASTICSEARCH_URL=http://x.x.x.x:9200" -e "SECRET_REGISTER=xxxxx"
     SetEnv ELASTICSEARCH_URL http://x.x.x.x:500
     SetEnv ELASTICSEARCH_USERNAME elastic
     SetEnv ELASTICSEARCH_PASSWORD changeme
+    SetEnv ELASTICSEARCH_API_KEY
 </VirtualHost>
 
 <VirtualHost *:80>
@@ -147,6 +150,7 @@ docker run -e "ELASTICSEARCH_URL=http://x.x.x.x:9200" -e "SECRET_REGISTER=xxxxx"
     SetEnv ELASTICSEARCH_URL http://x.x.x.x:600
     SetEnv ELASTICSEARCH_USERNAME elastic
     SetEnv ELASTICSEARCH_PASSWORD changeme
+    SetEnv ELASTICSEARCH_API_KEY
 </VirtualHost>
 
 <VirtualHost *:80>
@@ -158,6 +162,7 @@ docker run -e "ELASTICSEARCH_URL=http://x.x.x.x:9200" -e "SECRET_REGISTER=xxxxx"
     SetEnv ELASTICSEARCH_URL http://x.x.x.x:700
     SetEnv ELASTICSEARCH_USERNAME elastic
     SetEnv ELASTICSEARCH_PASSWORD changeme
+    SetEnv ELASTICSEARCH_API_KEY
 </VirtualHost>
 
 <VirtualHost *:80>
@@ -169,5 +174,6 @@ docker run -e "ELASTICSEARCH_URL=http://x.x.x.x:9200" -e "SECRET_REGISTER=xxxxx"
     SetEnv ELASTICSEARCH_URL http://x.x.x.x:800
     SetEnv ELASTICSEARCH_USERNAME elastic
     SetEnv ELASTICSEARCH_PASSWORD changeme
+    SetEnv ELASTICSEARCH_API_KEY
 </VirtualHost>
 ```

docs/index.md

@@ -37,7 +37,7 @@ Elasticsearch is a trademark of Elasticsearch BV, registered in the U.S. and in
 [(Back to table of contents)](#table-of-contents)
 
 - Supported Elasticsearch versions: 2.x, 5.x, 6.x, 7.x, 8.x
-- Connection to Elasticsearch: server-side (no CORS issue), private or public, local or remote, http or https, credentials or not
+- Connection to Elasticsearch: server-side (no CORS issue), private or public, local or remote, http or https, authorization with user/password or API key
 - App users: register, login, logout, list, create, read, update, delete
 - App roles: list, create, read, update (permissions), delete
 - Notifications (Push API, Email, Slack Incoming Webhook, Microsoft Teams Incoming Webhook) about cluster health, node up, node down, disk threshold, license expiration, ES version
@@ -129,7 +129,7 @@ docker run -e "ELASTICSEARCH_URL=http://x.x.x.x:9200" -e "SECRET_REGISTER=xxxxx"
 
 Edit ```ELASTICSEARCH_URL``` and ```SECRET_REGISTER``` (random string to secure registration)
 
-If Elasticsearch security features are enabled, add ```-e "ELASTICSEARCH_USERNAME=xxxxx" -e "ELASTICSEARCH_PASSWORD=xxxxx"```
+If Elasticsearch security features are enabled, add ```-e "ELASTICSEARCH_USERNAME=xxxxx" -e "ELASTICSEARCH_PASSWORD=xxxxx"``` or ```-e "ELASTICSEARCH_API_KEY=xxxxx"```
 
 If you have SSL certificates, add ```-v /path/privkey.pem:/etc/nginx/privkey.pem -v /path/fullchain.pem:/etc/nginx/fullchain.pem```
 
@@ -263,7 +263,7 @@ cp .env.dist .env
 
 In the ```.env``` file edit ```ELASTICSEARCH_URL``` and ```SECRET_REGISTER``` (random string to secure registration)
 
-If Elasticsearch security features are enabled, edit ```ELASTICSEARCH_USERNAME``` and ```ELASTICSEARCH_PASSWORD```
+If Elasticsearch security features are enabled, edit ```ELASTICSEARCH_USERNAME``` and ```ELASTICSEARCH_PASSWORD``` or ```-e "ELASTICSEARCH_API_KEY=xxxxx"```
 
 You can also edit ```VAPID_PUBLIC_KEY``` and ```VAPID_PRIVATE_KEY``` to use push notifications (only in HTTPS)
 

src/Manager/CallManager.php

@@ -81,6 +81,8 @@ class CallManager
 
     protected string $elasticsearchPassword;
 
+    protected string $elasticsearchApiKey;
+
     protected bool $sslVerifyPeer;
 
     protected bool $sslVerifyHost;
@@ -91,6 +93,7 @@ public function __construct(
         string $elasticsearchUrl,
         string $elasticsearchUsername,
         string $elasticsearchPassword,
+        string $elasticsearchApiKey,
         bool $sslVerifyPeer,
         bool $sslVerifyHost
     ) {
@@ -99,6 +102,7 @@ public function __construct(
         $this->elasticsearchUrl = $elasticsearchUrl;
         $this->elasticsearchUsername = $elasticsearchUsername;
         $this->elasticsearchPassword = $elasticsearchPassword;
+        $this->elasticsearchApiKey = $elasticsearchApiKey;
         $this->sslVerifyPeer = $sslVerifyPeer;
         $this->sslVerifyHost = $sslVerifyHost;
     }
@@ -123,7 +127,9 @@ public function call(CallRequestModel $callRequest): CallResponseModel
             $options['query']['format'] = 'json';
         }
 
-        if ($this->elasticsearchUsername && $this->elasticsearchPassword) {
+        if ($this->elasticsearchApiKey) {
+            $headers['Authorization'] = 'ApiKey '.$this->elasticsearchApiKey;
+        } else if ($this->elasticsearchUsername && $this->elasticsearchPassword) {
             $headers['Authorization'] = 'Basic '.base64_encode($this->elasticsearchUsername.':'.$this->elasticsearchPassword);
         }