From 2ca3a3f7db24938f5ab1d0f6333e39112c71f402 Mon Sep 17 00:00:00 2001
From: Kevin Papst <kevinpapst@users.noreply.github.com>
Date: Tue, 5 Apr 2022 17:49:41 +0200
Subject: [PATCH] interface for saml config (#3249)

---
 src/Configuration/SamlConfiguration.php       |  2 +-
 .../SamlConfigurationInterface.php            | 25 +++++++++++++++++++
 src/Saml/SamlAuthFactory.php                  |  4 +--
 src/Saml/User/SamlUserFactory.php             |  4 +--
 4 files changed, 30 insertions(+), 5 deletions(-)
 create mode 100644 src/Configuration/SamlConfigurationInterface.php

diff --git a/src/Configuration/SamlConfiguration.php b/src/Configuration/SamlConfiguration.php
index 826181f1..f5379280 100644
--- a/src/Configuration/SamlConfiguration.php
+++ b/src/Configuration/SamlConfiguration.php
@@ -9,7 +9,7 @@
 
 namespace App\Configuration;
 
-final class SamlConfiguration
+final class SamlConfiguration implements SamlConfigurationInterface
 {
     private $configuration;
 
diff --git a/src/Configuration/SamlConfigurationInterface.php b/src/Configuration/SamlConfigurationInterface.php
new file mode 100644
index 00000000..3af1fe59
--- /dev/null
+++ b/src/Configuration/SamlConfigurationInterface.php
@@ -0,0 +1,25 @@
+<?php
+
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Configuration;
+
+interface SamlConfigurationInterface
+{
+    public function isActivated(): bool;
+
+    public function getTitle(): string;
+
+    public function getAttributeMapping(): array;
+
+    public function getRolesAttribute(): ?string;
+
+    public function getRolesMapping(): array;
+
+    public function getConnection(): array;
+}
diff --git a/src/Saml/SamlAuthFactory.php b/src/Saml/SamlAuthFactory.php
index 3b7af2ae..6a43476c 100644
--- a/src/Saml/SamlAuthFactory.php
+++ b/src/Saml/SamlAuthFactory.php
@@ -9,7 +9,7 @@
 
 namespace App\Saml;
 
-use App\Configuration\SamlConfiguration;
+use App\Configuration\SamlConfigurationInterface;
 use OneLogin\Saml2\Auth;
 use OneLogin\Saml2\Utils;
 use Symfony\Component\HttpFoundation\RequestStack;
@@ -22,7 +22,7 @@ class SamlAuthFactory
     private $request;
     private $configuration;
 
-    public function __construct(RequestStack $request, SamlConfiguration $configuration)
+    public function __construct(RequestStack $request, SamlConfigurationInterface $configuration)
     {
         $this->request = $request;
         $this->configuration = $configuration;
diff --git a/src/Saml/User/SamlUserFactory.php b/src/Saml/User/SamlUserFactory.php
index b5d06a82..35003f4f 100644
--- a/src/Saml/User/SamlUserFactory.php
+++ b/src/Saml/User/SamlUserFactory.php
@@ -9,7 +9,7 @@
 
 namespace App\Saml\User;
 
-use App\Configuration\SamlConfiguration;
+use App\Configuration\SamlConfigurationInterface;
 use App\Entity\User;
 use App\Saml\Token\SamlTokenInterface;
 
@@ -17,7 +17,7 @@ final class SamlUserFactory
 {
     private $configuration;
 
-    public function __construct(SamlConfiguration $configuration)
+    public function __construct(SamlConfigurationInterface $configuration)
     {
         $this->configuration = $configuration;
     }