LdapBundle

KO | EN

gitlite — search

#hacktoberfest #android #php #javascript #java #dotnetnuke #python #dnn #dnncms #ios #css #game

★ 55 Open GitHub ↗

LdapBundle is an LDAP-based UserProvider for Symfony2's Security component.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# LdapBundle

This bundle implements an LDAP-based UserProvider for Symfony2's Security component.

When used in conjunction with Symfony2's HTTP basic authentication listener, this
bundle can verify usernames against an LDAP server and populate roles based on
groups to which the LDAP user belongs.

## Installation

### Dependencies

This bundle depends on the [Zend Framework 2](https://github.com/zendframework/zf2)
LDAP client.

If you don't already have the ZF2 codebase available in the vendor path of your
Symfony2 application, you may be interested in using [git-subtree](https://github.com/apenwarr/git-subtree)
to pull in the LDAP client by itself.  Instructions for this process are documented
in [this thread](https://groups.google.com/d/msg/symfony-devs/N-uIGhEWgs8/CrFmiLFYQbEJ)
from the symfony-devs mailing list.

### Submodule Creation

Add LdapBundle to your `src/` directory:

$ git submodule add https://github.com/opensky/LdapBundle.git vendor/bundles/OpenSky/Bundle/LdapBundle

### Class Autoloading

If the `src/` directory is already configured in your project's `autoload.php`
via `registerNamespaceFallback()`, no changes should be necessary.  Otherwise,
either define the fallback directory or explicitly add the "OpenSky" namespace:

# app/autoload.php

$loader->registerNamespaces(array(
        'OpenSky' => __DIR__.'/../vendor/bundles',
    ));

Additionally, ensure that the "Zend" namespace is also configured for autoloading.

### Application Kernel

Add LdapBundle to the `registerBundles()` method of your application kernel:

public function registerBundles()
    {
        return array(
            new OpenSky\Bundle\LdapBundle\OpenSkyLdapBundle(),
        );
    }

## Configuration

### LdapBundle Extension

The LDAP UserProvider may be configured with the following:

# app/config/config.yml

opensky_ldap:
        client:
            host: ldap.example.com
        user_base_dn:        ou=Users,dc=example,dc=com
        user_filter:         (objectClass=employee)
        username_attribute:  uid
        role_base_dn:        ou=Groups,dc=example,dc=com
        role_filter:         (objectClass=role)
        role_name_attribute: cn
        role_user_attribute: memberuid
        security:
            role_prefix:   ROLE_LDAP_
            default_roles: [ROLE_ADMIN, ROLE_LDAP]

These settings are explained below:

* `client`: array of options for the ZF2 LDAP client. Any options may be
   specified, although host is likely a minimum requirement.
 * `user_base_dn`: base DN when searching for users is LDAP.
 * `user_filter`: filter to apply when searching for users in LDAP.
 * `username_attribute`: user entry attribute to use as a username.
 * `role_base_dn`: base DN when searching for roles in LDAP.
 * `role_filter`: filter to apply when searching for roles in LDAP.
 * `role_name_attribute`: role entry attribute to use as the role name.
 * `role_user_attribute`: role entry attribute to use for inferring user
    relationships. Its value should be a set of user identifiers, which
    correspond to `usernameAttribute` values of user entries.
 * `security.role_prefix`: prefix to apply when transforming role names from LDAP
   entries into security roles. See: *Deriving Symfony2 Roles from LDAP Groups*
 * `security.default_roles`: array of default roles to be assigned to all LDAP
   users, before roles are inferred from user/role entry relationships.

LdapBundle

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README