minor #12050 [Ldap] Documented the deprecation related to query_string (javiereguiluz)

javiereguiluz · javiereguiluz · commit b6ecca987ea6 · 2019-09-26T17:09:43.000+02:00
This PR was squashed before being merged into the 4.4 branch (closes #12050). Discussion ---------- [Ldap] Documented the deprecation related to query_string I need help to come up with a good value for the `search_dn` option in this example. Also, should we mention this in the other place where we talk about `query_string`? Here: https://symfony.com/doc/current/reference/configuration/security.html#query-string Thanks. Commits ------- 382c5c8 [Ldap] Documented the deprecation related to query_string
diff --git a/security/ldap.rst b/security/ldap.rst
@@ -486,6 +486,8 @@ Configuration example for form login and query_string
                         service: Symfony\Component\Ldap\Ldap
                         dn_string: 'dc=example,dc=com'
                         query_string: '(&(uid={username})(memberOf=cn=users,ou=Services,dc=example,dc=com))'
+                        search_dn: '...'
+                        search_password: 'the-raw-password'
 
     .. code-block:: xml
 
@@ -502,7 +504,9 @@ Configuration example for form login and query_string
                     <form-login-ldap
                             service="Symfony\Component\Ldap\Ldap"
                             dn-string="dc=example,dc=com"
-                            query-string="(&amp;(uid={username})(memberOf=cn=users,ou=Services,dc=example,dc=com))"/>
+                            query-string="(&amp;(uid={username})(memberOf=cn=users,ou=Services,dc=example,dc=com))"
+                            search-dn="..."
+                            search-password="the-raw-password"/>
                 </firewall>
             </config>
         </srv:container>
@@ -519,12 +523,19 @@ Configuration example for form login and query_string
                         'service' => Ldap::class,
                         'dn_string' => 'dc=example,dc=com',
                         'query_string' => '(&(uid={username})(memberOf=cn=users,ou=Services,dc=example,dc=com))',
+                        'search_dn' => '...',
+                        'search_password' => 'the-raw-password',
                         // ...
                     ],
                 ],
             ]
         ]);
 
+.. deprecated:: 4.4
+
+    Using the ``query_string`` config option without defining ``search_dn`` and
+    ``search_password`` is deprecated since Symfony 4.4.
+
 .. _`LDAP PHP extension`: http://www.php.net/manual/en/intro.ldap.php
 .. _`RFC4515`: http://www.faqs.org/rfcs/rfc4515.html
 .. _`LDAP injection`: http://projects.webappsec.org/w/page/13246947/LDAP%20Injection
