meta data for this page
  •  

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
plugin:simplesaml [2025/03/22 14:11] – tatevikplugin:simplesaml [2025/03/22 15:24] (current) – add keycloak doc links tatevik
Line 1: Line 1:
-# SIMPLESAMLPHP PLUGIN+====== SIMPLESAMLPHP ======
  
-—- plugin —-  +---- plugin ----
 Description: This plugin provides Single Sign-on, `SSO` for `phpList` via the [`SIMPLESAMLPHP`](https://simplesamlphp.org/).   Description: This plugin provides Single Sign-on, `SSO` for `phpList` via the [`SIMPLESAMLPHP`](https://simplesamlphp.org/).  
 author : Fon E. Noel Nfebe <github.com/fenn-cs> author : Fon E. Noel Nfebe <github.com/fenn-cs>
-type :   +type : plugin 
-compatible : phpList 3.6.8 and above, PHP 7.4 and above +compatible : phpList 3.6.8 and above, PHP 7.4 and above  
-depends :   +similar :  https://github.com/TatevikGr/phplist-plugin-oidc
-conflicts :   +
-similar :  +
 tags : authentication tags : authentication
  
Line 15: Line 13:
 ---------- ----------
  
-# Installation+===== Installation =====
  
-### Plugin download+=== Plugin download ===
  
 The easiest way to setup this plugin is through the plugins page (menu Config > Manage plugins) using the package URL https://github.com/phpList/phplist-plugin-simplesaml/archive/refs/heads/main.zip The easiest way to setup this plugin is through the plugins page (menu Config > Manage plugins) using the package URL https://github.com/phpList/phplist-plugin-simplesaml/archive/refs/heads/main.zip
Line 23: Line 21:
 The plugin may be enabled at this point or after the `SimpleSAMLPHP` config described below. The plugin may be enabled at this point or after the `SimpleSAMLPHP` config described below.
  
-### SimpleSAMLPHP Installation+=== SimpleSAMLPHP Installation ===
  
 Plugin comes with a ready to use build of [`SIMPLESAMLPHP`](https://simplesamlphp.org/) (source code is slightly updated to work with phplist session logic). However, it is required that the server on which the `phpList` instance is running is configured to point to the `simplesamlphp` folder that comes in the plugin. Plugin comes with a ready to use build of [`SIMPLESAMLPHP`](https://simplesamlphp.org/) (source code is slightly updated to work with phplist session logic). However, it is required that the server on which the `phpList` instance is running is configured to point to the `simplesamlphp` folder that comes in the plugin.
Line 29: Line 27:
 Essentially, `your-phplist-domain.ext/simplesamlphp` should point to the folder in `main/simplesaml/simplesamlphp` of the extension or a copy of it on your server. Essentially, `your-phplist-domain.ext/simplesamlphp` should point to the folder in `main/simplesaml/simplesamlphp` of the extension or a copy of it on your server.
  
-*Advanced User: See [simplesaml config section](https://github.com/phpList/phplist-plugin-simplesaml#ways-to-configure-2-above) in the read me for more detailed information*+== Advanced User: See [simplesaml config section](https://github.com/phpList/phplist-plugin-simplesaml#ways-to-configure-2-above) in the read me for more detailed information ==
  
  
-### SimpleSAMLPHP Custom Configuration+===== Configuration =====
  
 By default, this plugin is configured to work with the `phpList`'s `Keyclaok` server. If you wish to change the identity provider, more configuration would be required. As described below. By default, this plugin is configured to work with the `phpList`'s `Keyclaok` server. If you wish to change the identity provider, more configuration would be required. As described below.
Line 38: Line 36:
 In `main/simplesaml/simplesamlphp/config/authsources.php` the following parameters have to be set: In `main/simplesaml/simplesamlphp/config/authsources.php` the following parameters have to be set:
  
-* **entityID**: The entityID is essentially the client ID which is specified in Keycloak or IDP + * **entityID**: The entityID is essentially the client ID which is specified in Keycloak or IDP 
-* **idp**: The IDP is the identifier for the IdP (Keycloak) which simplesaml would connect to. + * **idp**: The IDP is the identifier for the IdP (Keycloak) which simplesaml would connect to. 
-* **RelayState**: The RelayState specifies where simplesamlphp should redirect to after a successful authentication. Basically it's like a callback url. This should simply be the URL from which the authentication started. Hence, a 'redirect back'. + * **RelayState**: The RelayState specifies where simplesamlphp should redirect to after a successful authentication. Basically it's like a callback url. This should simply be the URL from which the authentication started. Hence, a 'redirect back'. 
-* **NameIDPolicy**: The IdP is expected to return a NameID every successful auth session, this name ID is what identifies the user. Depending on the IdP this NameID might change every session. That makes it impossible to tract the user across session. So we have to said the NameIDPolicy to persistent essentially telling the IdP to send the same NameID all the time for the same user.+ * **NameIDPolicy**: The IdP is expected to return a NameID every successful auth session, this name ID is what identifies the user. Depending on the IdP this NameID might change every session. That makes it impossible to tract the user across session. So we have to said the NameIDPolicy to persistent essentially telling the IdP to send the same NameID all the time for the same user.
  
  
Line 52: Line 50:
 For more information about the custom configuration see [Readme config section](https://github.com/phpList/phplist-plugin-simplesaml#configuration)) For more information about the custom configuration see [Readme config section](https://github.com/phpList/phplist-plugin-simplesaml#configuration))
  
-#### Installation for advanced users (git & terminal)+==== Installation for advanced users (git & terminal) ====
  
 See the README file on the GitHub page  [https://github.com/phpList/phplist-plugin-simplesaml](https://github.com/phpList/phplist-plugin-simplesaml) See the README file on the GitHub page  [https://github.com/phpList/phplist-plugin-simplesaml](https://github.com/phpList/phplist-plugin-simplesaml)
  
-## Plugin Activation+== Plugin Activation ==
  
 It is recommended to only enable the plugin only after the `SIMPLESAMLPHP` configs are set in the various configuration files described above and or in the [README](https://github.com/phpList/phplist-plugin-simplesaml#readme). It is recommended to only enable the plugin only after the `SIMPLESAMLPHP` configs are set in the various configuration files described above and or in the [README](https://github.com/phpList/phplist-plugin-simplesaml#readme).
  
-## Important Checks+== Important Checks ===
  
-### `SimpleSAMLPHP` Installation check+==== Keycloak ==== 
 + 
 +Configure Keycloak using this guide: https://resources.phplist.com/system/keycloak 
 +Documentation: https://www.keycloak.org/documentation 
 + 
 +=== `SimpleSAMLPHP` Installation check ===
 You should verify that `yourdomain.com/simplesamlphp` for example `phplist.com/simplesamlphp` loads the `simplesamlphp` files correctly and that `phplist.com/simplesamlphp/www` loads the `simplesamlphp` UI like the one shown below. You should verify that `yourdomain.com/simplesamlphp` for example `phplist.com/simplesamlphp` loads the `simplesamlphp` files correctly and that `phplist.com/simplesamlphp/www` loads the `simplesamlphp` UI like the one shown below.
  
Line 70: Line 73:
  
  
-### Testing +==== Activation ====
-#### Activation +
  
 After cloning the plugin in your plugin directory, you should login normally using your admin credentials and activate the plugin from the plugin management tab. After cloning the plugin in your plugin directory, you should login normally using your admin credentials and activate the plugin from the plugin management tab.
  
-#### Plugin has option to disable default login which can be done from phplist Menu->config->settings  +==== Plugin has option to disable default login which can be done from phplist Menu->config->settings  ====
  
  
-# Support +== Support == 
-Report any issues or questions in the support forum  [https://discuss.phplist.org/](https://discuss.phplist.org/ "https://discuss.phplist.org/")+Report any issues or questions in the support forum  [https://discuss.phplist.org/]