The Ldap Component

4.0 version
Maintained Unmaintained

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:

Then, require the vendor/autoload.php file to enable the autoloading mechanism provided by Composer. Otherwise, your application won't be able to find the classes of this Symfony component.

Usage

The Ldap class provides methods to authenticate and query against an LDAP server.

The Ldap class uses an AdapterInterface to communicate with an LDAP server. The adapter for PHP's built-in LDAP extension, for example, 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:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
use Symfony\Component\Ldap\Adapter\ExtLdap\Adapter;
use Symfony\Component\Ldap\Ldap;

$adapter = new Adapter(array(
    'host' => 'my-server',
    'port' => 389,
    'encryption' => 'tls',
    'options' => array(
        'protocol_version' => 3,
        'referrals' => false,
    ),
));
$ldap = new Ldap($adapter);

The bind() method authenticates a previously configured connection using both the distinguished name (DN) and the password of a user:

// ...

$ldap->bind($dn, $password);

Once bound (or if you enabled anonymous authentication on your LDAP server), you may query the LDAP server using the find() method:

// ...

$ldap->find('dc=symfony,dc=com', '(&(objectclass=person)(ou=Maintainers))');

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.