Merge pull request #35 from rutuja3407/saml_free_v11

Typo3 SAML Free (v5.2.0)

Classes/Controller/BesamlController.php

@@ -248,12 +248,9 @@ public function requestAction()
                 $this->view->assign('test_enabled', '');
             else
                 $this->view->assign('test_enabled', 'disabled');
-        } else {
-            if (isset($sp_object['sp_settings_saved']) && $sp_object['sp_settings_saved'] == true) {
-                $this->view->assign('idp_save_enabled', '');
-            } else {
-                $this->view->assign('idp_save_enabled', 'disabled');
-            }
+        } else 
+        {
+            $this->view->assign('idp_save_enabled', 'disabled');
             $this->view->assign('test_enabled', 'disabled');
         }
 

Configuration/Icons.php

@@ -18,10 +18,10 @@
 return [
     'sp-plugin-fesaml' => [
         'provider' => SvgIconProvider::class,
-        'source' => 'EXT:sp/Resources/Public/Icons/miniorange.png',
+        'source' => 'EXT:sp/Resources/Public/Icons/Extension.png',
     ],
     'sp-plugin-response' => [
         'provider' => SvgIconProvider::class,
-        'source' => 'EXT:sp/Resources/Public/Icons/miniorange.png',
+        'source' => 'EXT:sp/Resources/Public/Icons/Extension.png',
     ]
 ];

Documentation/Administrator/Index.rst

@@ -0,0 +1,82 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+
+.. _admin-manual:
+
+Administrator Manual
+====================
+
+Target group: **Administrators**
+
+Describes how to manage the extension from an administrator point of view.
+That relates to Page/User TSconfig, permissions, configuration etc.,
+which administrator level users have access to.
+
+Language should be non / semi-technical, explaining, using small examples.
+
+
+.. _admin-installation:
+
+Installation
+------------
+
+- How should the extension be installed?
+- Are they dependencies to resolve?
+- Is it a static template file to be included?
+
+To install the extension, perform the following steps:
+
+#. Go to the Extension Manager
+#. Install the extension
+#. Load the static template
+#. ...
+
+For a list of configuration options, using a definition list is recommended:
+
+Some Configuration
+  This option enables...
+
+Other configuration
+  This other option is for all the rest...
+
+
+.. figure:: ../Images/AdministratorManual/ExtensionManager.png
+   :alt: Extension Manager
+
+   Extension Manager (caption of the image)
+
+   List of extensions within the Extension Manager also shorten with "EM" (legend of the image)
+
+
+.. _admin-configuration:
+
+Configuration
+-------------
+
+* Where and how the extension should be configured? TypoScript? PHP?
+
+* Are there other prerequisite to full fill beforehand?
+  For example, configure a setting in a special way somewhere.
+
+
+.. _admin-faq:
+
+FAQ
+---
+
+Possible subsection: FAQ
+
+Subsection
+^^^^^^^^^^
+
+Some subsection
+
+Sub-subsection
+""""""""""""""
+
+Deeper into the structure...

Documentation/ChangeLog/Index.rst

@@ -0,0 +1,16 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+
+.. _changelog:
+
+ChangeLog
+=========
+
+Providing a change log chapter is optional. You can also refer
+users to the ChangeLog file inside the extension or to some repository's
+commit listing.

Documentation/IDP-Configurations.rst

@@ -0,0 +1,45 @@
+IDP-Configurations
+==================
+
+Identity Provider Metadata Configurations (Using XML Metadata)
+--------------------------------------------------------------
+
+* Either download the IDP Metadata file or copy the IDP Metadata URL from your Identity Provider
+* Navigate to the IDP Settings tab of the plugin and click on Upload IDP Metadata button
+* Add the name of your Identity Provider.
+* add the downloaded IDP Metadata file or paste the IDP Metadata URL copied from your Identity Provider and save it.
+
+.. figure:: Images/uploadmetadata.png
+   :alt: IDP XML Metadata Upload
+
+* Once you save the settings all the Metadata details will be fetched automatically.
+
+OR
+
+Identity Provider Metadata Configurations (Manually)
+----------------------------------------------------
+
+* Identity Provider Name: {Add your Identity Provider Name}
+* IDP Entity ID: {Add your Identity Provider Entity ID}
+* SAML Login URL: {Add your Identity Provider Single Sign On Service URL}
+* SAML x509 Certificate: {Add your Identity Provider x509 certificate}
+
+.. figure:: Images/idpconfigurations.png
+   :alt: Identity Provider Configurations
+
+* Once you configure both Identity Provider and Service Provider Metadata, click the Test Configuration button to check if the configurations are made correctly.
+
+.. figure:: Images/TestConfiguration.png
+   :alt: Test Configuration Window
+
+Default Group Mapping
+---------------------
+
+* Navigate to the Group Mapping tab of the plugin, select the default group to be assigned to the new users in Typo3 and save the settings.
+
+.. figure:: Images/RoleMapping.png
+   :alt: Group Mapping Settings
+
+* Once you have done all the above steps, you are ready to test the SSO. You can use your Fesaml Page URL in order to initiate the SSO.
+
+* If you are looking for anything which you cannot find, please drop us an email on [email protected]

Documentation/Includes.txt

@@ -0,0 +1,21 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. This is 'Includes.txt'. It is included at the very top of each and
+   every ReST source file in this documentation project (= manual).
+
+
+.. ==================================================
+.. DEFINE SOME TEXT ROLES
+.. --------------------------------------------------
+
+.. role::   typoscript(code)
+
+.. role::   ts(typoscript)
+   :class:  typoscript
+
+.. role::   php(code)
+
+.. highlight:: php

Documentation/Index.rst

@@ -0,0 +1,59 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: Includes.txt
+
+.. _start:
+
+=============================================================
+SAML Single Sign On SSO (Backend + Frontend)
+=============================================================
+
+.. only:: html
+
+	:Classification:
+		miniorange-saml
+
+	:Version:
+		|release|
+
+	:Language:
+		en
+
+	:Description:
+		SAML Single Sign On SSO (Backend + Frontend)
+
+	:Keywords:
+		saml sso, sso, single sign on, single sign-on, Azure AD, Okta, Google SSO, frontend, backend, login
+
+	:Copyright:
+		2021
+
+	:Author:
+		miniOrange
+
+	:Email:
+		[email protected]
+
+	:License:
+		This document is published under the Open Content License
+		available from http://www.opencontent.org/opl.shtml
+
+	:Rendered:
+		|today|
+
+	The content of this document is related to TYPO3,
+	a GNU/GPL CMS/Framework available from `www.typo3.org <http://www.typo3.org/>`_.
+
+	**Table of Contents**
+
+.. toctree::
+	:maxdepth: 3
+	:titlesonly:
+
+	Installation
+	SP-Configurations
+	IDP-Configurations
+

Documentation/Installation.rst

@@ -0,0 +1,27 @@
+Installation
+============
+
+Extension Installation
+**********************
+
+Using composer:
+---------------------
+
+Use the below command to install the extension using composer:
+
+.. code-block:: bash
+
+   composer req miniorange/miniorange-saml
+   
+OR 
+
+Using zip file:
+---------------------
+
+* Download the zip file of the miniOrange SAML SSO extension from TYPO3 marketplace.
+* Rename the zip file from miniorange_saml.zip to sp.zip
+* Go to your TYPO3 backend and click on Extensions section at the left side of your screen.
+* Upload the zip file as represented in the below image.
+
+.. image:: Images/upload.png
+    :alt: Upload Extension zip

Documentation/Introduction/Index.rst

@@ -0,0 +1,46 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+
+.. _introduction:
+
+Introduction
+============
+
+
+.. _what-it-does:
+
+What does it do?
+----------------
+
+This chapter should give a brief overview of the extension. What does it do? What problems does it solve?
+Who is interested in this? Basically, this section includes everything people need to know to decide whether they
+should go on with this extension or not.
+
+.. important::
+
+   Please don't forget to repeat your extension's version number in the
+   :file:`Settings.yml` file, in the :code:`release` property. It will be
+   automatically picked up on the cover page by the :code:`|release|`
+   substitution.
+
+
+.. _screenshots:
+
+Screenshots
+-----------
+
+This chapter should help people figure how the extension works. Remove it
+if not relevant.
+
+.. figure:: ../Images/IntroductionPackage.png
+   :width: 500px
+   :alt: Introduction Package
+
+   Introduction Package just after installation (caption of the image)
+
+   How the Frontend of the Introduction Package looks like just after installation (legend of the image)

Documentation/SP-Configurations.rst

@@ -0,0 +1,37 @@
+SP-Configurations
+=================
+
+Pre-requirements Before Configuring SP-Configurations
+*********************************************
+
+You must have atleast two pages before configuring the extension.
+
+.. tip:: Pages can be created by the following steps:-
+
+* Navigate to the Pages section and create new standard page with name fesaml and add fesaml plugin to it.
+* Similarly create a page named response and and response plugin to it.
+* You can refer to the below screenshots for the same.
+.. image:: Images/fesaml.png
+    :alt: Fesaml Page
+.. image:: Images/response.png
+    :alt: Response Page
+* Create SSO Login button in your Typo3 Frontend Site and embed the fesaml page URL to it in order to initiate the SSO.
+
+
+Service Provider Metadata Configurations
+****************************************
+
+* Once the extension is installed successfully, navigate to the SP settings tab and configure the fields as below:
+	- Fesaml plugin page URL: {URL of the Fesaml standard page created in earlier steps}
+	- Response plugin page URL: {URL of the Response standard page created in earlier steps}
+	- Base URL: {Base URL of your Typo3 site}
+	- ACS URL: {URL of the Response standard page created in earlier steps}
+	- Issuer/Entity ID: {Base URL of your Typo3 site}
+
+.. figure:: Images/spconfigurations.png
+   :alt: Service Provider Configurations
+
+* Once you save the above details, you can download the SP XML Metadata or you can use XML Metadata URL to upload it in your Identity Provider or you can upload it manually.
+
+* You can choose the setup guide specific to your Identity Provider from below link:
+https://plugins.miniorange.com/typo3-saml-sso-setup-guides

Documentation/Settings.cfg

@@ -0,0 +1,15 @@
+[general]
+project     = SAML Single Sign On SSO (Backend + Frontend)
+release     = 5.5.0
+copyright   = 2021
+description = SAML SSO for Typo3 frontend and Backend
+
+
+[html_theme_options]
+github_branch     = master
+github_repository = miniOrangeDev/miniorange-saml-typo3-sso
+
+project_contact    = mailto:[email protected]
+project_home       = https://github.com/miniOrangeDev/miniorange-saml-typo3-sso
+project_issues     = https://github.com/miniOrangeDev/miniorange-saml-typo3-sso/issues
+project_repository = https://github.com/miniOrangeDev/miniorange-saml-typo3-sso

composer.json

@@ -19,7 +19,7 @@
       "Miniorange\\Sp\\": "Classes/"
     }
   },
-  "version": "2.0.9",
+  "version": "5.5.0",
   "config": {
     "allow-plugins": {
       "typo3/class-alias-loader": true,