Merge pull request #80 from dBucik/api_write

Feat: API write

Author: Dominik František Bučík

README.md

@@ -73,3 +73,26 @@ Once you have installed SimpleSAMLphp, installing this module is very simple. Fi
 ```
 'instance_name' => 'Instance name',
 ```
+
+### Writing via API
+#### Configuration
+Add the following (and adjust the credentials) to enable writing via the API (example request following). Methods supported are `POST,PUT`.
+```
+  'apiWriteEnabled' => true,
+  'apiWriteUsername' => 'api_writer',
+  'apiWritePasswordHash' => password_hash('ap1Wr1T3rP@S$'),
+```
+#### Example request
+```
+curl --request POST \
+  --url https://proxy.com/proxy/module.php/proxystatistics/writeLoginApi.php \
+  --header 'Authorization: Basic encodedCredentials' \
+  --header 'Content-Type: application/json' \
+  --data '{
+	"userId": "[email protected]",
+	"serviceIdentifier": "https://service.com/shibboleth",
+	"serviceName": "TEST_SERVICE",
+	"idpIdentifier": "https://idp.org/simplesamlphp",
+	"idpName": "TEST_IDP"
+}'
+```

composer.json

@@ -23,7 +23,7 @@
     }
   },
   "require": {
-    "php": "^7.1 || ^8",
+    "php": "^7.3 || ^8",
     "ext-ctype": "*",
     "ext-filter": "*",
     "ext-json": "*",

composer.lock

@@ -87,4 +87,19 @@
      * For how many days should the detailed statistics be kept. Minimum is 31.
      */
     //'keepPerUser' => 62,
+
+    /*
+     * Enables ability to write via an API
+     */
+    //'apiWriteEnabled' => true,
+
+    /*
+     * Username to protect API write endpoint (has no effect if write is disabled)
+     */
+    //'apiWriteUsername' => 'api_writer',
+
+    /*
+     * Password to protect API write endpoint (has no effect if write is disabled)
+     */
+    //'apiWritePasswordHash' => password_hash('ap1Wr1T3rP@S$'),
 ];

config-templates/module_proxystatistics.php

@@ -26,7 +26,7 @@ public function process(&$request)
         $dateTime = new DateTime();
         $dbCmd = new DatabaseCommand();
         try {
-            $dbCmd->insertLogin($request, $dateTime);
+            $dbCmd->insertLoginFromFilter($request, $dateTime);
         } catch (Exception $ex) {
             Logger::error(
                 self::DEBUG_PREFIX . 'Caught exception while inserting login into statistics: ' . $ex->getMessage()

lib/Auth/Process/Statistics.php

@@ -5,6 +5,7 @@
 namespace SimpleSAML\Module\proxystatistics;
 
 use SimpleSAML\Configuration;
+use SimpleSAML\Error\Exception;
 
 class Config
 {
@@ -34,6 +35,12 @@ class Config
 
     private const KEEP_PER_USER = 'keepPerUser';
 
+    private const API_WRITE_ENABLED = 'apiWriteEnabled';
+
+    private const API_WRITE_USERNAME = 'apiWriteUsername';
+
+    private const API_WRITE_PASSWORD_HASH = 'apiWritePasswordHash';
+
     private $config;
 
     private $store;
@@ -50,6 +57,12 @@ class Config
 
     private $idAttribute;
 
+    private $apiWriteEnabled;
+
+    private $apiWriteUsername;
+
+    private $apiWritePasswordHash;
+
     private static $instance;
 
     private function __construct()
@@ -62,6 +75,17 @@ private function __construct()
         $this->keepPerUser = $this->config->getIntegerRange(self::KEEP_PER_USER, 31, 1827, 31);
         $this->requiredAuthSource = $this->config->getString(self::REQUIRE_AUTH_SOURCE, '');
         $this->idAttribute = $this->config->getString(self::USER_ID_ATTRIBUTE, 'uid');
+        $this->apiWriteEnabled = $this->config->getBoolean(self::API_WRITE_ENABLED, false);
+        if ($this->apiWriteEnabled) {
+            $this->apiWriteUsername = $this->config->getString(self::API_WRITE_USERNAME);
+            if (empty(trim($this->apiWriteUsername))) {
+                throw new Exception('Username for API write cannot be empty');
+            }
+            $this->apiWritePasswordHash = $this->config->getString(self::API_WRITE_PASSWORD_HASH);
+            if (empty(trim($this->apiWritePasswordHash))) {
+                throw new Exception('Password for API write cannot be empty');
+            }
+        }
     }
 
     private function __clone()
@@ -123,4 +147,19 @@ public function getKeepPerUser()
     {
         return $this->keepPerUser;
     }
+
+    public function isApiWriteEnabled()
+    {
+        return $this->apiWriteEnabled;
+    }
+
+    public function getApiWriteUsername()
+    {
+        return $this->apiWriteUsername;
+    }
+
+    public function getApiWritePasswordHash()
+    {
+        return $this->apiWritePasswordHash;
+    }
 }