-
-
Notifications
You must be signed in to change notification settings - Fork 5.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* 2.8: Remove old File Upload article + improve the new one Added documentation for the Ldap component Conflicts: reference/configuration/security.rst
- Loading branch information
Showing
14 changed files
with
898 additions
and
619 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
.. index:: | ||
single: Ldap | ||
single: Components; Ldap | ||
|
||
The Ldap Component | ||
================== | ||
|
||
The Ldap component provides a means to connect to an LDAP server (OpenLDAP or Active Directory). | ||
|
||
Installation | ||
------------ | ||
|
||
You can install the component in 2 different ways: | ||
|
||
* :doc:`Install it via Composer </components/using_components>` (``symfony/ldap`` on `Packagist`_); | ||
* Use the official Git repository (https://github.com/symfony/ldap). | ||
|
||
.. include:: /components/require_autoload.rst.inc | ||
|
||
Usage | ||
----- | ||
|
||
The :class:`Symfony\\Component\\Ldap\\LdapClient` class provides methods | ||
to authenticate and query against an LDAP server. | ||
|
||
The :class:`Symfony\\Component\\Ldap\\LdapClient` class can be configured | ||
using the following options: | ||
|
||
``host`` | ||
IP or hostname of the LDAP server | ||
|
||
``port`` | ||
Port used to access the LDAP server | ||
|
||
``version`` | ||
The version of the LDAP protocol to use | ||
|
||
``useSsl`` | ||
Whether or not to secure the connection using SSL | ||
|
||
``useStartTls`` | ||
Whether or not to secure the connection using StartTLS | ||
|
||
``optReferrals`` | ||
Specifies whether to automatically follow referrals | ||
returned by the LDAP server | ||
|
||
For example, to connect to a start-TLS secured LDAP server:: | ||
|
||
use Symfony\Component\Ldap\LdapClient; | ||
|
||
$ldap = new LdapClient('my-server', 389, 3, false, true); | ||
|
||
The :method:`Symfony\\Component\\Ldap\\LdapClient::bind` method | ||
authenticates a previously configured connection using both the | ||
distinguished name (DN) and the password of a user:: | ||
|
||
use Symfony\Component\Ldap\LdapClient; | ||
// ... | ||
|
||
$ldap->bind($dn, $password); | ||
|
||
Once bound (or if you enabled anonymous authentication on your | ||
LDAP server), you may query the LDAP server using the | ||
:method:`Symfony\\Component\\Ldap\\LdapClient::find` method:: | ||
|
||
use Symfony\Component\Ldap\LdapClient; | ||
// ... | ||
|
||
$ldap->find('dc=symfony,dc=com', '(&(objectclass=person)(ou=Maintainers))'); | ||
|
||
.. _Packagist: https://packagist.org/packages/symfony/ldap |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.