PHP and WordPress Single Sign On (SSO) with optional JWT Addon

maicol07

Flarum SSO

This extension is the updated Single Sign On for Flarum extension.

The following information and this whole post may be outdated. Please always refer to the 📝 docs which are always updated

This extension equips Flarum with Single Sign On (shortly SSO). Basically, this extension will act as a bridge between Flarum and your SSO/Auth system. The extension is useful if you run Flarum on a subdomain but you want to use the login mechanism of your main website or Flarum.

If you have an OpenID Connect provider/auth system you can use my OpenID Connect Client Extension, that requires zero coding from your side. You only have to configure it and you're ready to go!

How does it work?

The workflow is explained in the 📝 docs

Available plugins for the extension

This extension works with plugins that links Flarum to your SSO system. Current plugins are listed in the 📝 docs.

Installation

Install via command below or via Bazaar and activate the extension.

composer require maicol07/flarum-ext-sso

More detailed instructions are written in the 📝 docs.

Upgrading

Upgrade via command below or via Bazaar.

composer update maicol07/flarum-ext-sso

More detailed instructions are written in the 📝 docs.

How to use

Check the 📝docs

Docs and Premium Addons

The extension is fully documented here.
You can find in the plugins page (check the sidebar on the left) the available addons such as the Groups and JWT one.
Some addons are free (or bundled in in the plugins but not enabled by default), while others are premium, available only after a subscription.
To know what is the difference between plugins and addons check this section of the docs.

Links

jordanjay29

maicol07 You will want to follow the new version constraint recommendation in your composer.json file, as described here (under composer.json > require).

Artuu

maicol07 If AddClientAssets.php file is not used in any way, it can be deleted.

ck04

maicol07 hi i am trying to implement sso in flarum , i am using react js dashboard. so when click on forum link it will redirect to forum.i need forum auto login when user click forum link from dashboard. can you tell me how can i do this

maicol07

jordanjay29 yep, I'll do it

maicol07

Release 1.3.1 - Minor tweak

This release includes a small tweak in composer.json file (thank you @jordanjay29)

Changelog

Major changes are marked with ❗️

Minor tweak to composer.json file

Updating

Run composer update command or use Bazaar

maicol07

Artuu I will see what this file do and if it is unused I will delete it

gus

It doesn't work for me.
You rename the class Forum by Flarum change but you didn't change it in index.php and logout.php.
Regardless of this, I can't make it works. Is it working for you ?

maicol07

gus Example website is not currently updated. For now, refer to class methods comments. If you have any questions please tell me. I'll update the example website soon

gus

Ah ok thank you.
I have this error when sendRequest() is called :

Warning: file_get_contents(/api/token): failed to open stream: No such file or directory in ...

Warning: file_get_contents(/api/users): failed to open stream: No such file or directory in ...

I wonder if the problem comes from my server, do you have an idea ?

maicol07

gus Do you have added your Flarum URL into config,php?
I've noticed now there is a little bug that blocks request sending.
New version fixing it should be out in minutes...

maicol07

1.3.2 - Critical fixes

This release includes some critical fixes that caused the extension to not work.

Changelog

Major changes are marked with ❗️

❗️ Critical fixes that caused the extension to not work.
Updated sample website example

Updating

Run composer update command or use Bazaar

gus

maicol07 , thanks for answer, yes I didn't update config.php (return (object) was missing).
But I have another problem ! ☹️

The function file_get_content() always returns :
You don't have permission to access /api/token on this server.

Here is the header :
array(1) { ["http"]=> array(4) { ["header"]=> string(71) "Authorization: Token myToken; userId=1" ["method"]=> string(4) "POST" ["content"]=> string(91) "password=f3ccb2b2c2f17dcdfa849cd7e33d50371ad3d98e3d939311e21de9211ed9bc2e&lifetime=31536000" ["ignore_errors"]=> bool(true) } }

However, the api key is the same in the database, do you know why it doesn't work ?

maicol07

gus have you set your user ID along with your token in the api_keys table?

gus

maicol07 Of course !

<?php
return (object) [
    // URL to your Flarum forum
    'flarum_url' => 'https://forum.mywebsite.fr',
    // Domain of your main site (without http://)
    'root_domain' => 'mywebsite.fr',
    // Create a random key in the api_keys table of your Flarum forum
    'flarum_api_key' => 'myToken',
    // Random token to create passwords
    'password_token' => 'myToken',
    // How many days should the login be valid
    'lifetime_in_days' => 365,
];

(myToken contains letters and digits)

gus

Yes, here is what I added in the api_keys table :

key : myToken
id : 1
allowed_ips : NULL
scopes : NULL
user_id : 1
created_at : 2019-10-16 00:00:00
last_activity_a : NULL

The user_id 1 is the admin

maicol07

gus May I see your config.php file?

maicol07

gus this should work. If you open Web Console (F12) --> Network when you do a request to Flarum you'll se a XHR request. Could you open it and send here the screenshot of that?
P.S.: Sorry for the late reply

gus

maicol07
There is no XHR request, I'm still trying to fix the issue, but I don't have any idea.

Here is the error : Warning: file_get_contents(https://forum.myWebsite.fr/api/token): failed to open stream: HTTP request failed! HTTP/1.1 403 Forbidden in...

YoungJinKim

maicol07 why sire:

Rootzilla

Where is "sample-website" folder and "config.php.dist" file. Can you tell in more detail please ?

maicol07

Rootzilla you can download the ZIP from GitHub. You will find the sample-website folder and, inside it, the config.php.dist