Как подключить Adldap2 в Yii2?

Question

[Коал Коалыч]

Подскажите, пожалуйста, с какого бока подойти к https://github.com/Adldap2/Adldap2/ ? Читаю от https://github.com/Adldap2/Adldap2/blob/master/doc... и далее и не понимаю, как и где его подключить? Сам пакет установлен. Может, кто-нибудь показать на примере?

Answer 1

[Дмитрий]

Доброе утро.
Если Вы устанавливали пакет через composer, то в файле composer.json должен упоминаться этот Ваш пакет.
А значит в нужном файле, в самом начале, Вы должны подключить класс пакета через "use" и дальше использовать его, как написано в инструкции.

use \Adldap\Adldap;

$ad = new Adldap();

Comments

[Коал Коалыч]

а где конфиг описать? судя по документации не похоже, что это main.php или web.php

[Дмитрий]

Коал Коалыч, оформите как отдельный компонент, например.

Answer 2

[DieZz]

Если вопрос еще актуален, могу поделится своей реализацией
В первую очередь я создал компонент который является обореткой для Adldap

spoiler

<?php

namespace app\components;

use Adldap\Adldap;
use Adldap\Auth\BindException;
use Adldap\Auth\PasswordRequiredException;
use Adldap\Auth\UsernameRequiredException;
use Adldap\Connections\ProviderInterface;
use Adldap\Models\Group;
use Adldap\Models\Model;
use Adldap\Models\User;
use app\components\interfaces\ExternalAuthProviderInterface;
use Illuminate\Support\Collection;
use yii\base\Component;

/**
 * Class LdapService
 * Wrapper to work with LDAP package.
 *
 * @package app\components
 */
class LdapService extends Component implements ExternalAuthProviderInterface
{
    /**
     * Account suffix.
     *
     * @var string
     */
    public $accountSuffix = '';
    /**
     * List of domain controllers.
     *
     * @var array
     */
    public $domainControllers = [];
    /**
     * Base DN.
     *
     * @var string
     */
    public $baseDn;
    /**
     * Domain admin user name.
     *
     * @var string
     */
    public $adminUserName;
    /**
     * Domain admin password.
     *
     * @var string
     */
    public $adminPassword;
    /**
     * Connection provider to the AD.
     *
     * @var ProviderInterface
     */
    private $provider;

    /**
     * Attempt to login in domain.
     *
     * @param string $login    login.
     * @param string $password password.
     *
     * @throws BindException if there are connections errors.
     * @throws PasswordRequiredException
     * @throws UsernameRequiredException
     *
     * @return bool
     */
    public function attempt(string $login, string $password): bool
    {
        return $this->getProvider()
            ->auth()
            ->attempt($login, $password);
    }

    /**
     * Find user in the AD by login(account name).
     *
     * @param string $login login/account name.
     *
     * @throws \Adldap\Models\ModelNotFoundException
     * @throws BindException
     * @throws \InvalidArgumentException
     * @return User|Model
     */
    public function findUserByLogin(string $login): User
    {
        return $this->getProvider()
            ->search()
            ->users()
            ->where('samaccountname', '=', $login)
            ->firstOrFail();
    }

    /**
     * Find user in the AD by full name.
     *
     * @param string $username users full name.
     *
     * @throws \Adldap\Models\ModelNotFoundException
     * @throws BindException
     * @throws \InvalidArgumentException
     * @return User|Model
     */
    public function findUserByFullName(string $username): User
    {
        return $this->getProvider()
            ->search()
            ->users()
            ->where('cn', '=', $username)
            ->firstOrFail();
    }

    /**
     * Returns list of all group in the AD.
     *
     * @throws BindException
     * @return Collection|Group[]
     */
    public function getAllGroups(): Collection
    {
        return $this->getProvider()
            ->search()
            ->groups()
            ->get();
    }

    /**
     * Returns configured AD provider.
     *
     * @throws BindException
     * @return ProviderInterface
     */
    private function getProvider(): ProviderInterface
    {
        if (null === $this->provider) {
            $ad = new Adldap($this->getConfig());
            $this->provider = $ad->connect('default');
        }

        return $this->provider;
    }

    /**
     * Returns config to connect to the ldap domain.
     *
     * @return array
     */
    private function getConfig(): array
    {
        return [
            'default' => [
                'domain_controllers' => $this->domainControllers,
                'base_dn'            => $this->baseDn,
                'admin_username'     => $this->adminUserName,
                'admin_password'     => $this->adminPassword,
                'account_suffix'     => $this->accountSuffix,
            ],
        ];
    }
}

Теперь этот компонент необходимо подключить через конфиг приложения

spoiler

'components' => [
        ...
        'ldap' => [
            'class'             => \app\components\LdapService::class,
            'accountSuffix'     => '@test',
            'domainControllers' => ['192.168.1.1'],
            'baseDn'            => 'DC=admin',
            'adminUserName'     => 'admin',
            'adminPassword'     => 'password',
        ],
    ],

И далее уже можем использовать его в нашем коде

$user = \Yii::$app->get('ldap')->findUserByLogin('someLogin');