factorenergia/yii2-ldap

Ldap

Ldap database and ActiveRecord for Yii 2

This extension provides the LDAP integration for the Yii framework 2.0. It includes basic querying/search support and also implements the ActiveRecord pattern that allows you to store active records in Active Directory or OpenLDAP., _(*1)

Requirements

To use yii2-ldap, your sever must support:, _(*2)

PHP LDAP Extension, _(*3)

Installation

The preferred way to install this extension is through composer., _(*4)

Either run, _(*5)

php composer.phar require --prefer-dist factorenergia/yii2-ldap

or add, _(*6)

"factorenergia/yii2-ldap": "*"

to the require section of your composer.json., _(*7)

Configuration

return [
    //....
    'components' => [
        'ldap' => [
            'class' => 'factorenergia\ldap\Connection',
            // Mandatory Configuration Options
            'dc' => [
                '192.168.1.1',
                'ad.com'
            ],
            'baseDn'          => 'dc=ad,dc=com',
            'username'        => 'administrator@ad.com',
            'password'        => 'password',
            // Optional Configuration Options
            'port'            => 389,
            'followReferrals' => false,
            'useTLS'          => true,
            // Change pageSize (e.g. to 1000) if you are getting the following message
            // with large result sets:
            // ldap_search(): Partial search results returned: Sizelimit exceeded
            'pageSize'        => -1,
        ],
    ]
];

Authenticating Users

To authenticate users using your AD server, call the Yii::$app->ldap->auth() method on your provider:, _(*8)

try {
    if (Yii::$app->ldap->auth($this->username, $password)) {
        // Credentials were correct.
    } else {
        // Credentials were incorrect.
    }
} catch (Exception $e) {            
    // error
}