[Ldap] Improving the LDAP component #17560

csarrazi · 2016-01-27T10:45:49Z

Q	A
Bug fix?	no
New feature?	yes
BC breaks?	yes
Deprecations?	no
Tests pass?	no
Fixed tickets	#14602
License	MIT
Doc PR	not yet

This PR will address a few issues mentioned in #14602.

Integrate the Config component in order to simplify the client's configuration
Separate Connection handling from the Client
Support for multiple drivers
Add functional tests
Update Security component

javiereguiluz · 2016-01-27T11:08:38Z

src/Symfony/Component/Ldap/Connection/Connection.php

+    public function __construct(array $config = array())
+    {
+        if (!extension_loaded('ldap')) {
+            throw new LdapException('The ldap module is needed.');


Could we change this error message by something like: The ldap PHP extension is not enabled ?

ChadSikorra · 2016-01-27T15:27:59Z

Is support for paging planned to be implemented in the query? For many corporate LDAP implementations a max page size is enforced as a best practice, and large queries will fail without paging.

However, I guess adding that might be a bit cumbersome as paging support for LDAP was added in PHP 5.4 and the min requirement for this component is 5.3.

csarrazi · 2016-01-27T17:14:19Z

There's no issue with supporting paging, especially as version 3.0 of Symfony only supports PHP 5.5+. Thus, we could implement this.

However, I won't support this right now, but maybe in a later PR.

The goal of this PR is to be able to make the component more flexible, and make the correct abstractions, so different implementations can be used (using the PHP extension, for example). This way, we could support a userland ldap client, or even third-party libraries to provide such capability.

csarrazi · 2016-01-27T17:25:46Z

src/Symfony/Component/Ldap/Adapter/AbstractQuery.php

+            'maxItems' => 0,
+            'sizeLimit' => 0,
+            'timeout' => 0,
+            'deref' => LDAP_DEREF_NEVER,


Constants should be moved in QueryInterface.

csarrazi · 2016-01-27T18:44:17Z

By the way, as this PR breaks compatibility, the code from the Security component will be updated in another PR.

csarrazi · 2016-02-05T23:08:11Z

Ping @fabpot @nicolas-grekas

This PR is now stable, and a functional tests have been bootstrapped.

csarrazi · 2016-02-05T23:23:35Z

The only build failing is the Appveyor build, as the CI does not have a LDAP server.

Does anyone have a solution?

csarrazi · 2016-02-05T23:28:41Z

For now, I'm disabling the ldap extension for the Windows build. The component will be unsupported on Windows, until we have a way to run functional tests on the platform.

fabpot · 2016-02-06T07:14:55Z

src/Symfony/Component/Ldap/LdapFactory.php

+/**
+ * @author Charles Sarrazin <[email protected]>
+ */
+final class LdapFactory


Why do we need this class for? I would remove it altogether as it does not add anything useful AFAICS.

The class is simply a shorthand way to create the Ldap class. Indeed, otherwise, you need to manually inject the adapter (and other configuration). This is basically to improve DX.

But we don't have any other such classes anywhere in Symfony. So, I would remove it for now.

I will merge the static method in the Ldap class. The idea was to have something like PropertyAccess::createPropertyAccessor().

fabpot · 2016-02-10T12:07:30Z

src/Symfony/Component/Ldap/LdapClient.php

-
-        $this->connection = null;
-    }
-}


Isn't it possible to keep this class for BC and proxy to the new one?

Good idea. What I will do:

create a LdapClient class, implementing LdapClientInterface and wrapping the Ldap class.

create a backward-compatible constructor initializing a Ldap instance.

move the find() method from the Ldap class to the LdapClient class.

* Moved connection logic to dedicated class * Added support for Ldap result entries iterator and renamed LdapClient to Ldap * Added support for multiple adapters * Attempt anonymous bind if the connection is not bound beforehand * Finalized API * Updated the Security component to use v3.1 of the Ldap component * Updated unit tests * Added support for functional tests * Updated README file

csarrazi · 2016-02-11T18:14:16Z

All done!

It seems some tests fail because of VarDumper.

csarrazi · 2016-02-11T18:32:26Z

Ping @xabbuh @fabpot @dunglas @nicolas-grekas

fabpot · 2016-02-12T08:23:09Z

👍

fabpot · 2016-02-14T10:16:25Z

Thank you @csarrazi.

This PR was merged into the 3.1-dev branch. Discussion ---------- [Ldap] Improving the LDAP component | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | BC breaks? | yes | Deprecations? | no | Tests pass? | no | Fixed tickets | #14602 | License | MIT | Doc PR | not yet This PR will address a few issues mentioned in #14602. * [x] Integrate the Config component in order to simplify the client's configuration * [x] Separate Connection handling from the Client * [x] Support for multiple drivers * [x] Add functional tests * [x] Update Security component Commits ------- 34d3c85 Added compatibility layer for previous version of the Security component 81cb79b Improved the Ldap Component

xabbuh · 2016-02-14T12:42:41Z

.travis.yml

@@ -48,6 +50,11 @@ before_install:
    - if [[ $deps != skip ]]; then composer self-update; fi;
    - if [[ $deps != skip ]]; then ./phpunit install; fi;
    - export PHPUNIT=$(readlink -f ./phpunit)
+    - mkdir /tmp/slapd
+    - slapd -f src/Symfony/Component/Ldap/Tests/Fixtures/conf/slapd.conf -h ldap://localhost:3389 &
+    - sleep 3


Do we really need this? And why three seconds? This looks like it may cause wrong build failure reports in the future.

slapd is run in the background. Also, this ensures that the daemon is started before the test are run. We could remove this, but tests may be flaky.

This PR was merged into the 3.1 branch. Discussion ---------- [Security] Allow LDAP loadUser override | Q | A | ------------- | --- | Branch? | 3.1 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - Back to 3.0, one could extend `Symfony\Component\Security\Core\User\LdapUserProvider` and override how User objects are created. Among several improvements, #17560 changed `loadUser` signature but also visibility to `private` which disallow any overriding. Even if the signature BC break is legitimate, we should still be able to override this method IMHO, which is not possible with a private visibility. This PRs introduces a `protected` visibility to allow again overriding. Commits ------- ae99aa8 [Security] Allow LDAP loadUser override

carsonbot added the Status: Needs Review label Jan 27, 2016

javiereguiluz reviewed Jan 27, 2016
View reviewed changes

csarrazi reviewed Jan 27, 2016
View reviewed changes

csarrazi changed the title ~~Improving the LDAP component~~ [Ldap] Improving the LDAP component Jan 27, 2016

csarrazi mentioned this pull request Jan 27, 2016

[Security] [WIP] Update the Security component to reflect changes to the Ldap component #17577

Closed

csarrazi changed the title ~~[Ldap] Improving the LDAP component~~ [Ldap] [RFR] Improving the LDAP component Jan 28, 2016

csarrazi changed the title ~~[Ldap] [RFR] Improving the LDAP component~~ [Ldap] [WIP] Improving the LDAP component Jan 28, 2016

csarrazi mentioned this pull request Feb 1, 2016

[Security] [Ldap] [Easy-Pick] Limit ldap component version for branch 3.0 #17588

Merged

csarrazi changed the title ~~[Ldap] [WIP] Improving the LDAP component~~ [Ldap] [RFR] Improving the LDAP component Feb 5, 2016

csarrazi changed the title ~~[Ldap] [RFR] Improving the LDAP component~~ [Ldap] Improving the LDAP component Feb 5, 2016

csarrazi mentioned this pull request Feb 5, 2016

implement add and delete method #17679

Closed

fabpot reviewed Feb 6, 2016
View reviewed changes

fabpot reviewed Feb 10, 2016
View reviewed changes

xabbuh added Status: Needs Work and removed Status: Needs Review labels Feb 10, 2016

csarrazi added 2 commits February 11, 2016 18:54

Added compatibility layer for previous version of the Security component

34d3c85

fabpot merged commit 34d3c85 into symfony:master Feb 14, 2016

xabbuh reviewed Feb 14, 2016
View reviewed changes

csarrazi deleted the feat-improve-ldap branch February 14, 2016 19:49

fabpot mentioned this pull request May 13, 2016

Release v3.1.0-BETA1 #18776

Merged

tucksaun mentioned this pull request Jun 28, 2016

[Security] Allow LDAP loadUser override #19204

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Ldap] Improving the LDAP component #17560

[Ldap] Improving the LDAP component #17560

csarrazi commented Jan 27, 2016

javiereguiluz Jan 27, 2016

ChadSikorra commented Jan 27, 2016

csarrazi commented Jan 27, 2016

csarrazi Jan 27, 2016

csarrazi commented Jan 27, 2016

csarrazi commented Feb 5, 2016

csarrazi commented Feb 5, 2016

csarrazi commented Feb 5, 2016

fabpot Feb 6, 2016

csarrazi Feb 6, 2016

fabpot Feb 6, 2016

csarrazi Feb 8, 2016

fabpot Feb 8, 2016

fabpot Feb 10, 2016

csarrazi Feb 10, 2016

csarrazi commented Feb 11, 2016

csarrazi commented Feb 11, 2016

fabpot commented Feb 12, 2016

fabpot commented Feb 14, 2016

xabbuh Feb 14, 2016

csarrazi Feb 14, 2016

[Ldap] Improving the LDAP component #17560

[Ldap] Improving the LDAP component #17560

Conversation

csarrazi commented Jan 27, 2016

Choose a reason for hiding this comment

ChadSikorra commented Jan 27, 2016

csarrazi commented Jan 27, 2016

Choose a reason for hiding this comment

csarrazi commented Jan 27, 2016

csarrazi commented Feb 5, 2016

csarrazi commented Feb 5, 2016

csarrazi commented Feb 5, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

csarrazi commented Feb 11, 2016

csarrazi commented Feb 11, 2016

fabpot commented Feb 12, 2016

fabpot commented Feb 14, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment