LDAP login extension

TitusPiJean

Hi all,

I have put together a LDAP login extension.

Version: v0.1.0-beta.16-1
Status : Works. Maybe needs some refining depending on the use cases.

Installation:
LDAP interface is brought by the ldaprecord package. You need to have PHP's LDAP extension installed.

composer require tituspijean/flarum-ext-auth-ldap

Features:

multiple user identification fields (uid, mail, cn, ...)
multiple base_dn
raw LDAP filters (e.g. for group matching)
retrieval of mail
hide Flarum's default login system

Bugs and enhancements

I only have one LDAP server from YunoHost to test the extension, so do not hesitate to report any issue or missing parameter on your side.
Please report issues there after enabling debug mode.

Enjoy !

TitusPiJean

ℹ v0.2-dev
Now the login link does not override the default login modal by default. It will be safer to test. ? There is an option is the extension settings to only use LDAP for logging in.

BlackSheep

Really nice extension ?

popi

I like the idea and appreciate the sharing! However I could not get passed the login screen, though the authentication is successful. I updated issue #6 on Github.
I was wondering if someone got it working on current beta release 0.1.0-beta.7?

TitusPiJean

ℹ v0.6-dev
- Issue that have been brought up by popi has been solved. Extension now handles signing up the user when it does not exist yet in Flarum. Extension is working!
- Successful login is now correctly handled, thank you @popi and @Franz for helping out!

➡ future developments:
I will implement an option to include displayName when it is supported by the core.

Yourforest

TitusPiJean is there any plan to release new version to compatible with Beta 8 😀

cdknight

How do I configure this extension?

s3ns3

Would also be very interested in this extension.. 😃

TitusPiJean

Hi all,
I'm working on fixing this extension. You can test it in the v0.1.0-beta.9-1 branch. It is working, but it has some rough UX edges (you need to manually refresh the page after logging in, and some settings are not found by the forum). You can have a look to this issue on its repository.
Feel free to help out, I'm quite stuck with these issues.

TitusPiJean

ℹ️ v1.0
The extension is fixed and working on beta.10!
Many thanks to @clarkwinkelmann and @datitisev for guiding me out of the most blocking issues.

RossL

I've installed and activated this plugin. When ever I try logging in with an LDAP user a window pops up with the message:

An error occurred while trying to load this page.

clarkwinkelmann

RossL please look in your log files and copy the full error message for us. The message will likely be in either Flarum logs in <flarum>/storage/logs or your PHP logs.

RossL

Hi clarkwinkelmann

Thank you for your reply, I'm new to Flarum and still trying to find my way around.

I've taken a look at the logs and pasted the error message below

[2020-02-06 14:10:18] production.ERROR: Exception: Unspecified error during LDAP authentication in /var/www/html/forum/vendor/tituspijean/flarum-ext-auth-ldap/src/Controllers/LDAPAuthController.php:78
Stack trace:
#0 /var/www/html/forum/vendor/flarum/core/src/Http/RouteHandlerFactory.php(38): TitusPiJean\Flarum\Auth\LDAP\Controllers\LDAPAuthController->handle(Object(Zend\Diactoros\ServerRequest))
#1 /var/www/html/forum/vendor/flarum/core/src/Http/Middleware/DispatchRoute.php(65): Flarum\Http\RouteHandlerFactory->Flarum\Http{closure}(Object(Zend\Diactoros\ServerRequest), Array)
#2 /var/www/html/forum/vendor/zendframework/zend-stratigility/src/Next.php(60): Flarum\Http\Middleware\DispatchRoute->process(Object(Zend\Diactoros\ServerRequest), Object(Closure))
#3 /var/www/html/forum/vendor/flarum/core/src/Http/Middleware/ShareErrorsFromSession.php(56): Zend\Stratigility\Next->handle(Object(Zend\Diactoros\ServerRequest))
#4 /var/www/html/forum/vendor/zendframework/zend-stratigility/src/Next.php(60): Flarum\Http\Middleware\ShareErrorsFromSession->process(Object(Zend\Diactoros\ServerRequest), Object(Zend\Stratigility\Next))
#5 /var/www/html/forum/vendor/flarum/core/src/Http/Middleware/SetLocale.php(50): Zend\Stratigility\Next->handle(Object(Zend\Diactoros\ServerRequest))
#6 /var/www/html/forum/vendor/zendframework/zend-stratigility/src/Next.php(60): Flarum\Http\Middleware\SetLocale->process(Object(Zend\Diactoros\ServerRequest), Object(Zend\Stratigility\Next))
#7 /var/www/html/forum/vendor/flarum/core/src/Http/Middleware/CheckCsrfToken.php(31): Zend\Stratigility\Next->handle(Object(Zend\Diactoros\ServerRequest))
#8 /var/www/html/forum/vendor/zendframework/zend-stratigility/src/Next.php(60): Flarum\Http\Middleware\CheckCsrfToken->process(Object(Zend\Diactoros\ServerRequest), Object(Zend\Stratigility\Next))
#9 /var/www/html/forum/vendor/flarum/core/src/Http/Middleware/AuthenticateWithSession.php(32): Zend\Stratigility\Next->handle(Object(Zend\Diactoros\ServerRequest))
#10 /var/www/html/forum/vendor/zendframework/zend-stratigility/src/Next.php(60): Flarum\Http\Middleware\AuthenticateWithSession->process(Object(Zend\Diactoros\ServerRequest), Object(Zend\Stratigility\Next))
#11 /var/www/html/forum/vendor/flarum/core/src/Http/Middleware/RememberFromCookie.php(51): Zend\Stratigility\Next->handle(Object(Zend\Diactoros\ServerRequest))
#12 /var/www/html/forum/vendor/zendframework/zend-stratigility/src/Next.php(60): Flarum\Http\Middleware\RememberFromCookie->process(Object(Zend\Diactoros\ServerRequest), Object(Zend\Stratigility\Next))
#13 /var/www/html/forum/vendor/flarum/core/src/Http/Middleware/StartSession.php(61): Zend\Stratigility\Next->handle(Object(Zend\Diactoros\ServerRequest))
#14 /var/www/html/forum/vendor/zendframework/zend-stratigility/src/Next.php(60): Flarum\Http\Middleware\StartSession->process(Object(Zend\Diactoros\ServerRequest), Object(Zend\Stratigility\Next))
#15 /var/www/html/forum/vendor/flarum/core/src/Http/Middleware/CollectGarbage.php(46): Zend\Stratigility\Next->handle(Object(Zend\Diactoros\ServerRequest))
#16 /var/www/html/forum/vendor/zendframework/zend-stratigility/src/Next.php(60): Flarum\Http\Middleware\CollectGarbage->process(Object(Zend\Diactoros\ServerRequest), Object(Zend\Stratigility\Next))
#17 /var/www/html/forum/vendor/flarum/core/src/Http/Middleware/ParseJsonBody.php(28): Zend\Stratigility\Next->handle(Object(Zend\Diactoros\ServerRequest))
#18 /var/www/html/forum/vendor/zendframework/zend-stratigility/src/Next.php(60): Flarum\Http\Middleware\ParseJsonBody->process(Object(Zend\Diactoros\ServerRequest), Object(Zend\Stratigility\Next))
#19 /var/www/html/forum/vendor/flarum/core/src/Http/Middleware/HandleErrors.php(57): Zend\Stratigility\Next->handle(Object(Zend\Diactoros\ServerRequest))
#20 /var/www/html/forum/vendor/zendframework/zend-stratigility/src/Next.php(60): Flarum\Http\Middleware\HandleErrors->process(Object(Zend\Diactoros\ServerRequest), Object(Zend\Stratigility\Next))
#21 /var/www/html/forum/vendor/zendframework/zend-stratigility/src/MiddlewarePipe.php(83): Zend\Stratigility\Next->handle(Object(Zend\Diactoros\ServerRequest))
#22 /var/www/html/forum/vendor/middlewares/request-handler/src/RequestHandler.php(84): Zend\Stratigility\MiddlewarePipe->process(Object(Zend\Diactoros\ServerRequest), Object(Zend\Stratigility\Next))
#23 /var/www/html/forum/vendor/zendframework/zend-stratigility/src/Next.php(60): Middlewares\RequestHandler->process(Object(Zend\Diactoros\ServerRequest), Object(Zend\Stratigility\Next))
#24 /var/www/html/forum/vendor/middlewares/base-path-router/src/BasePathRouter.php(97): Zend\Stratigility\Next->handle(Object(Zend\Diactoros\ServerRequest))
#25 /var/www/html/forum/vendor/zendframework/zend-stratigility/src/Next.php(60): Middlewares\BasePathRouter->process(Object(Zend\Diactoros\ServerRequest), Object(Zend\Stratigility\Next))
#26 /var/www/html/forum/vendor/zendframework/zend-stratigility/src/Middleware/OriginalMessages.php(41): Zend\Stratigility\Next->handle(Object(Zend\Diactoros\ServerRequest))
#27 /var/www/html/forum/vendor/zendframework/zend-stratigility/src/Next.php(60): Zend\Stratigility\Middleware\OriginalMessages->process(Object(Zend\Diactoros\ServerRequest), Object(Zend\Stratigility\Next))
#28 /var/www/html/forum/vendor/middlewares/base-path/src/BasePath.php(53): Zend\Stratigility\Next->handle(Object(Zend\Diactoros\ServerRequest))
#29 /var/www/html/forum/vendor/zendframework/zend-stratigility/src/Next.php(60): Middlewares\BasePath->process(Object(Zend\Diactoros\ServerRequest), Object(Zend\Stratigility\Next))
#30 /var/www/html/forum/vendor/zendframework/zend-stratigility/src/MiddlewarePipe.php(83): Zend\Stratigility\Next->handle(Object(Zend\Diactoros\ServerRequest))
#31 /var/www/html/forum/vendor/zendframework/zend-stratigility/src/MiddlewarePipe.php(72): Zend\Stratigility\MiddlewarePipe->process(Object(Zend\Diactoros\ServerRequest), Object(Zend\Stratigility\EmptyPipelineHandler))
#32 /var/www/html/forum/vendor/zendframework/zend-httphandlerrunner/src/RequestHandlerRunner.php(95): Zend\Stratigility\MiddlewarePipe->handle(Object(Zend\Diactoros\ServerRequest))
#33 /var/www/html/forum/vendor/flarum/core/src/Http/Server.php(44): Zend\HttpHandlerRunner\RequestHandlerRunner->run()
#34 /var/www/html/forum/index.php(22): Flarum\Http\Server->listen()
#35 {main}

TitusPiJean

ℹ️ v0.1.0-beta.12-2

Going back to Flarum's version naming convention, with extension-specific iterations after the final dash.
The extension is compatible with beta.12!
Backend dependency: adldap2 has been replaced with ldaprecord
Users can now be identified by other fields than uid (e.g. mail, cn, it's up to you!)
Email and display name are now retrieved (customizable fields, too)
Logins can now be tested against multiple base_dn
Custom LDAP filters can be also added (e.g. for groups matching)

Many thanks to CodazziS for his great contribution, and @ornanovitch for his suggestions and swift feedback that make the extension better.

⚠️ Due to my backpedalling regarding versions naming, you may need to perform the following commands to upgrade:

composer remove tituspijean/flarum-ext-auth-ldap
composer clear-cache # makes composer forget about v1.0
composer require tituspijean/flarum-ext-auth-ldap

luceos

TitusPiJean v1 is higher than this latest version. People will therefor always install v1. Is this intended?

TitusPiJean

luceos That's something I was afraid of. ~~Should I remove the v1.0 release?~~
~~Actually maybe not, since v1.0 is not compatible with flarum > v0.1.0-beta.10 ?~~
v1.0 release removed from packagist, and instructions added to post above.

luceos

TitusPiJean remove it from github as well (under releases and tags) otherwise it will be automatically readded.