factorenergia/yii2-ldap

Ldap

2.0.0 2020-05-05 09:07 UTC

Requires

• php: >=7.0
• ext-ldap: *
• yiisoft/yii2: ~2.0.14

Requires (Dev)

• codeception/codeception: *
• yiisoft/yii2-apidoc: *
• yiisoft/yii2-coding-standards: *

MIT

• Christopher Mota

• extension
• ldap
• active directory
• yii2
• openldap

README

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.

Requirements

To use yii2-ldap, your sever must support:

PHP LDAP Extension

Installation

The preferred way to install this extension is through composer.

Either run

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

or add

"factorenergia/yii2-ldap": "*"

to the require section of your composer.json.

Configuration

return [
    //....
    'components' => [
        'ldap' => [
            'class' => 'factorenergia\ldap\Connection',
            // Mandatory Configuration Options
            'dc' => [
                '192.168.1.1',
                'ad.com'
            ],
            'baseDn'          => 'dc=ad,dc=com',
            'username'        => '[e-mail]',
            '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:

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