class.ilLDAPQuery.php

Go to the documentation of this file.

<?php
/*
    +-----------------------------------------------------------------------------+
    | ILIAS open source                                                           |
    +-----------------------------------------------------------------------------+
    | Copyright (c) 1998-2006 ILIAS open source, University of Cologne            |
    |                                                                             |
    | This program is free software; you can redistribute it and/or               |
    | modify it under the terms of the GNU General Public License                 |
    | as published by the Free Software Foundation; either version 2              |
    | of the License, or (at your option) any later version.                      |
    |                                                                             |
    | This program is distributed in the hope that it will be useful,             |
    | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
    | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
    | GNU General Public License for more details.                                |
    |                                                                             |
    | You should have received a copy of the GNU General Public License           |
    | along with this program; if not, write to the Free Software                 |
    | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
    +-----------------------------------------------------------------------------+
*/

define('IL_LDAP_BIND_DEFAULT', 0);
define('IL_LDAP_BIND_ADMIN', 1);
define('IL_LDAP_BIND_TEST', 2);
define('IL_LDAP_BIND_AUTH', 10);

class ilLDAPQuery
{
    public const LDAP_BIND_DEFAULT = 0;
    public const LDAP_BIND_ADMIN = 1;
    public const LDAP_BIND_TEST = 2;
    public const LDAP_BIND_AUTH = 10;

    const IL_LDAP_CONTROL_PAGEDRESULTS = '1.2.840.113556.1.4.319';

    const IL_LDAP_SUPPORTED_CONTROL = 'supportedControl';

    const PAGINATION_SIZE = 100;

    private $ldap_server_url = null;
    private $settings = null;
    
    private $log = null;
    
    private $user_fields = array();

    private $lh;
    
    public function __construct(ilLDAPServer $a_server, $a_url = '')
    {
        $this->settings = $a_server;
        
        if (strlen($a_url)) {
            $this->ldap_server_url = $a_url;
        } else {
            $this->ldap_server_url = $this->settings->getUrl();
        }
        
        $this->mapping = ilLDAPAttributeMapping::_getInstanceByServerId($this->settings->getServerId());
        $this->log = $GLOBALS['DIC']->logger()->auth();
        
        $this->fetchUserProfileFields();
        $this->connect();
    }
    
    // begin-patch ldap_multiple
    public function getServer()
    {
        return $this->settings;
    }
    
    public function getLogger()
    {
        return $this->log;
    }
    
    public function fetchUser($a_name)
    {
        if (!$this->readUserData($a_name)) {
            return array();
        } else {
            return $this->users;
        }
    }
    
    
    public function fetchUsers()
    {
        // First of all check if a group restriction is enabled
        // YES: => fetch all group members
        // No:  => fetch all users
        if (strlen($this->settings->getGroupName())) {
            $this->log->debug('Searching for group members.');

            $groups = $this->settings->getGroupNames();
            if (count($groups) <= 1) {
                $this->fetchGroupMembers();
            } else {
                foreach ($groups as $group) {
                    $this->fetchGroupMembers($group);
                }
            }
        }
        if (!strlen($this->settings->getGroupName()) or $this->settings->isMembershipOptional()) {
            $this->log->info('Start reading all users...');
            $this->readAllUsers();
            #throw new ilLDAPQueryException('LDAP: Called import of users without specifying group restrictions. NOT IMPLEMENTED YET!');
        }
        return $this->users ? $this->users : array();
    }
    
    public function query($a_search_base, $a_filter, $a_scope, $a_attributes)
    {
        $res = $this->queryByScope($a_scope, $a_search_base, $a_filter, $a_attributes);
        if ($res === false) {
            throw new ilLDAPQueryException(__METHOD__ . ' ' . ldap_error($this->lh) . ' ' .
                sprintf(
                    'DN: %s, Filter: %s, Scope: %s',
                    $a_search_base,
                    $a_filter,
                    $a_scope
                ));
        }
        return (new ilLDAPResult($this->lh, $res))->run();
    }
    
    public function modAdd($a_dn, $a_attribute)
    {
        if (@ldap_mod_add($this->lh, $a_dn, $a_attribute)) {
            return true;
        }
        throw new ilLDAPQueryException(__METHOD__ . ' ' . ldap_error($this->lh));
    }
    
    public function modDelete($a_dn, $a_attribute)
    {
        if (@ldap_mod_del($this->lh, $a_dn, $a_attribute)) {
            return true;
        }
        throw new ilLDAPQueryException(__METHOD__ . ' ' . ldap_error($this->lh));
    }
    
    private function readAllUsers()
    {
        // Build search base
        if (($dn = $this->settings->getSearchBase()) && substr($dn, -1) != ',') {
            $dn .= ',';
        }
        $dn .= $this->settings->getBaseDN();
        $tmp_result = null;

        if ($this->checkPaginationEnabled()) {
            try {
                $tmp_result = $this->runReadAllUsersPaged($dn);
            } catch (ilLDAPPagingException $e) {
                $this->log->warning('Using LDAP with paging failed. Trying to use fallback.');
                $tmp_result = $this->runReadAllUsersPartial($dn);
            }
        } else {
            $tmp_result = $this->runReadAllUsersPartial($dn);
        }

        if (!$tmp_result->numRows()) {
            $this->log->notice('No users found. Aborting.');
        }
        $this->log->info('Found ' . $tmp_result->numRows() . ' users.');
        $attribute = strtolower($this->settings->getUserAttribute());
        foreach ($tmp_result->getRows() as $data) {
            if (isset($data[$attribute])) {
                $this->readUserData($data[$attribute], false, false);
            } else {
                $this->log->warning('Unknown error. No user attribute found.');
            }
        }
        unset($tmp_result);

        return true;
    }

    private function runReadAllUsersPaged($dn)
    {
        $filter = '(&' . $this->settings->getFilter();
        $filter .= ('(' . $this->settings->getUserAttribute() . '=*))');
        $this->log->info('Searching with ldap search and filter ' . $filter . ' in ' . $dn);

        $tmp_result = new ilLDAPResult($this->lh);
        $cookie = '';
        $estimated_results = 0;
        do {
            try {
                $res = ldap_control_paged_result($this->lh, self::PAGINATION_SIZE, true, $cookie);
                if ($res === false) {
                    throw new ilLDAPPagingException('Result pagination failed.');
                }

            } catch (Exception $e) {
                $this->log->warning('Result pagination failed with message: ' . $e->getMessage());
                throw new ilLDAPPagingException($e->getMessage());
            }

            $res = $this->queryByScope(
                $this->settings->getUserScope(),
                $dn,
                $filter,
                array($this->settings->getUserAttribute())
            );
            $tmp_result->setResult($res);
            $tmp_result->run();
            try {
                ldap_control_paged_result_response($this->lh, $res, $cookie, $estimated_results);
                $this->log->debug('Estimated number of results: ' . $estimated_results);
            } catch (Exception $e) {
                $this->log->warning('Result pagination failed with message: ' . $e->getMessage());
                throw new ilLDAPPagingException($e->getMessage());
            }
        } while ($cookie !== null && $cookie != '');

        // finally reset cookie
        ldap_control_paged_result($this->lh, 10000, false, $cookie);
        return $tmp_result;
    }

    private function runReadAllUsersPartial($dn)
    {
        $filter = $this->settings->getFilter();
        $page_filter = array('a','b','c','d','e','f','g','h','i','j','k','l','m','n','o','p','q','r','s','t','u','v','w','x','y','z','-');
        $chars = array('a','b','c','d','e','f','g','h','i','j','k','l','m','n','o','p','q','r','s','t','u','v','w','x','y','z');
        $tmp_result = new ilLDAPResult($this->lh);

        foreach ($page_filter as $letter) {
            $new_filter = '(&';
            $new_filter .= $filter;

            switch ($letter) {
                case '-':
                    $new_filter .= ('(!(|');
                    foreach ($chars as $char) {
                        $new_filter .= ('(' . $this->settings->getUserAttribute() . '=' . $char . '*)');
                    }
                    $new_filter .= ')))';
                    break;

                default:
                    $new_filter .= ('(' . $this->settings->getUserAttribute() . '=' . $letter . '*))');
                    break;
            }

            $this->log->info('Searching with ldap search and filter ' . $new_filter . ' in ' . $dn);
            $res = $this->queryByScope(
                $this->settings->getUserScope(),
                $dn,
                $new_filter,
                array($this->settings->getUserAttribute())
            );
            $tmp_result->setResult($res);
            $tmp_result->run();
        }

        return $tmp_result;
    }

    public function checkGroupMembership($a_ldap_user_name, $ldap_user_data)
    {
        $group_names = $this->getServer()->getGroupNames();
        
        if (!count($group_names)) {
            $this->getLogger()->debug('No LDAP group restrictions found');
            return true;
        }
        
        $group_dn = $this->getServer()->getGroupDN();
        if (
            $group_dn &&
            (substr($group_dn, -1) != ',')
        ) {
            $group_dn .= ',';
        }
        $group_dn .= $this->getServer()->getBaseDN();
        
        foreach ($group_names as $group) {
            $user = $a_ldap_user_name;
            if ($this->getServer()->enabledGroupMemberIsDN()) {
                if ($this->getServer()->enabledEscapeDN()) {
                    $user = ldap_escape($ldap_user_data['dn'], "", LDAP_ESCAPE_FILTER);
                } else {
                $user = $ldap_user_data['dn'];
            }
            }
            
            $filter = sprintf(
                '(&(%s=%s)(%s=%s)%s)',
                $this->getServer()->getGroupAttribute(),
                $group,
                $this->getServer()->getGroupMember(),
                $user,
                $this->getServer()->getGroupFilter()
            );
            $this->getLogger()->debug('Current group search base: ' . $group_dn);
            $this->getLogger()->debug('Current group filter: ' . $filter);
            
            $res = $this->queryByScope(
                $this->getServer()->getGroupScope(),
                $group_dn,
                $filter,
                [$this->getServer()->getGroupMember()]
            );
            
            $this->getLogger()->dump($res);
            
            $tmp_result = new ilLDAPResult($this->lh, $res);
            $tmp_result->run();
            $group_result = $tmp_result->getRows();
            
            $this->getLogger()->debug('Group query returned: ');
            $this->getLogger()->dump($group_result, ilLogLevel::DEBUG);
            
            if (count($group_result)) {
                return true;
            }
        }
        
        // group restrictions failed check optional membership
        if ($this->getServer()->isMembershipOptional()) {
            $this->getLogger()->debug('Group restrictions failed, checking user filter.');
            if ($this->readUserData($a_ldap_user_name, true, true)) {
                $this->getLogger()->debug('User filter matches.');
                return true;
            }
        }
        $this->getLogger()->debug('Group restrictions failed.');
        return false;
    }
    

    private function fetchGroupMembers($a_name = '')
    {
        $group_name = strlen($a_name) ? $a_name : $this->settings->getGroupName();
        
        // Build filter
        $filter = sprintf(
            '(&(%s=%s)%s)',
            $this->settings->getGroupAttribute(),
            $group_name,
            $this->settings->getGroupFilter()
        );
        
        
        // Build search base
        if (($gdn = $this->settings->getGroupDN()) && substr($gdn, -1) != ',') {
            $gdn .= ',';
        }
        $gdn .= $this->settings->getBaseDN();
        
        $this->log->debug('Using filter ' . $filter);
        $this->log->debug('Using DN ' . $gdn);
        $res = $this->queryByScope(
            $this->settings->getGroupScope(),
            $gdn,
            $filter,
            array($this->settings->getGroupMember())
        );
            
        $tmp_result = new ilLDAPResult($this->lh, $res);
        $tmp_result->run();
        $group_data = $tmp_result->getRows();
        
        
        if (!$tmp_result->numRows()) {
            $this->log->info('No group found.');
            return false;
        }
                
        $attribute_name = strtolower($this->settings->getGroupMember());
        
        // All groups
        foreach ($group_data as $data) {
            if (is_array($data[$attribute_name])) {
                    $this->log->debug('Found ' . count($data[$attribute_name]) . ' group members for group ' . $data['dn']);
                foreach ($data[$attribute_name] as $name) {
                    $this->readUserData($name, true, true);
                }
            } else {
                $this->readUserData($data[$attribute_name], true, true);
            }
        }
        unset($tmp_result);
        return;
    }
    
    private function readUserData($a_name, $a_check_dn = false, $a_try_group_user_filter = false)
    {
        $filter = $this->settings->getFilter();
        if ($a_try_group_user_filter) {
            if ($this->settings->isMembershipOptional()) {
                $filter = $this->settings->getGroupUserFilter();
            }
        }
        
        // Build filter
        if ($this->settings->enabledGroupMemberIsDN() and $a_check_dn) {
            $dn = $a_name;
            #$res = $this->queryByScope(IL_LDAP_SCOPE_BASE,$dn,$filter,$this->user_fields);

            $fields = array_merge($this->user_fields, array('useraccountcontrol'));
            $res = $this->queryByScope(IL_LDAP_SCOPE_BASE, strtolower($dn), $filter, $fields);
        } else {
            $filter = sprintf(
                '(&(%s=%s)%s)',
                $this->settings->getUserAttribute(),
                $a_name,
                $filter
            );

            // Build search base
            if (($dn = $this->settings->getSearchBase()) && substr($dn, -1) != ',') {
                $dn .= ',';
            }
            $dn .= $this->settings->getBaseDN();
            $fields = array_merge($this->user_fields, array('useraccountcontrol'));
            $res = $this->queryByScope($this->settings->getUserScope(), strtolower($dn), $filter, $fields);
        }
        
        
        $tmp_result = new ilLDAPResult($this->lh, $res);
        $tmp_result->run();
        if (!$tmp_result->numRows()) {
            $this->log->info('LDAP: No user data found for: ' . $a_name);
            unset($tmp_result);
            return false;
        }
        
        if ($user_data = $tmp_result->get()) {
            if (isset($user_data['useraccountcontrol'])) {
                if (($user_data['useraccountcontrol'] & 0x02)) {
                    $this->log->notice('LDAP: ' . $a_name . ' account disabled.');
                    return;
                }
            }
            
            $account = $user_data[strtolower($this->settings->getUserAttribute())];
            if (is_array($account)) {
                $user_ext = strtolower(array_shift($account));
            } else {
                $user_ext = strtolower($account);
            }
            
            // auth mode depends on ldap server settings
            $auth_mode = $this->settings->getAuthenticationMappingKey();
            $user_data['ilInternalAccount'] = ilObjUser::_checkExternalAuthAccount($auth_mode, $user_ext);
            $this->users[$user_ext] = $user_data;
        }
        return true;
    }

    private function parseAuthMode()
    {
        return $this->settings->getAuthenticationMappingKey();
    }
    
    private function queryByScope($a_scope, $a_base_dn, $a_filter, $a_attributes)
    {
        $a_filter = $a_filter ? $a_filter : "(objectclass=*)";

        switch ($a_scope) {
            case IL_LDAP_SCOPE_SUB:
                $res = @ldap_search($this->lh, $a_base_dn, $a_filter, $a_attributes);
                break;
                
            case IL_LDAP_SCOPE_ONE:
                $res = @ldap_list($this->lh, $a_base_dn, $a_filter, $a_attributes);
                break;
            
            case IL_LDAP_SCOPE_BASE:

                $res = @ldap_read($this->lh, $a_base_dn, $a_filter, $a_attributes);
                break;

            default:
                $this->log->warning("LDAP: LDAPQuery: Unknown search scope");
        }
        
        $error = ldap_error($this->lh);
        if (strcmp('Success', $error) !== 0) {
            $this->getLogger()->warning($error);
            $this->getLogger()->warning('Base DN:' . $a_base_dn);
            $this->getLogger()->warning('Filter: ' . $a_filter);
        }
        
        return $res;
    }
    
    private function connect()
    {
        $this->lh = @ldap_connect($this->ldap_server_url);
        
        // LDAP Connect
        if (!$this->lh) {
            throw new ilLDAPQueryException("LDAP: Cannot connect to LDAP Server: " . $this->settings->getUrl());
        }
        // LDAP Version
        if (!ldap_set_option($this->lh, LDAP_OPT_PROTOCOL_VERSION, $this->settings->getVersion())) {
            throw new ilLDAPQueryException("LDAP: Cannot set version to: " . $this->settings->getVersion());
        }
        // Switch on referrals
        if ($this->settings->isActiveReferrer()) {
            if (!ldap_set_option($this->lh, LDAP_OPT_REFERRALS, true)) {
                throw new ilLDAPQueryException("LDAP: Cannot switch on LDAP referrals");
            }
            #@ldap_set_rebind_proc($this->lh,'referralRebind');
        } else {
            ldap_set_option($this->lh, LDAP_OPT_REFERRALS, false);
            $this->log->debug('Switching referrals to false.');
        }
        // Start TLS
        if ($this->settings->isActiveTLS()) {
            if (!ldap_start_tls($this->lh)) {
                throw new ilLDAPQueryException("LDAP: Cannot start LDAP TLS");
            }
        }
    }
    
    public function bind($a_binding_type = IL_LDAP_BIND_DEFAULT, $a_user_dn = '', $a_password = '')
    {
        switch ($a_binding_type) {
            case IL_LDAP_BIND_TEST:
                ldap_set_option($this->lh, LDAP_OPT_NETWORK_TIMEOUT, ilLDAPServer::DEFAULT_NETWORK_TIMEOUT);
                // fall through
                // no break
            case IL_LDAP_BIND_DEFAULT:
                // Now bind anonymously or as user
                if (
                    IL_LDAP_BIND_USER == $this->settings->getBindingType() &&
                    strlen($this->settings->getBindUser())
                ) {
                    $user = $this->settings->getBindUser();
                    $pass = $this->settings->getBindPassword();

                    define('IL_LDAP_REBIND_USER', $user);
                    define('IL_LDAP_REBIND_PASS', $pass);
                    $this->log->debug('Bind as ' . $user);
                } else {
                    $user = $pass = '';
                    $this->log->debug('Bind anonymous');
                }
                break;
                
            case IL_LDAP_BIND_ADMIN:
                $user = $this->settings->getRoleBindDN();
                $pass = $this->settings->getRoleBindPassword();
                
                if (!strlen($user) or !strlen($pass)) {
                    $user = $this->settings->getBindUser();
                    $pass = $this->settings->getBindPassword();
                }

                define('IL_LDAP_REBIND_USER', $user);
                define('IL_LDAP_REBIND_PASS', $pass);
                break;
                
            case IL_LDAP_BIND_AUTH:
                $this->log->debug('Trying to bind as: ' . $a_user_dn);
                $user = $a_user_dn;
                $pass = $a_password;
                break;
                
                
            default:
                throw new ilLDAPQueryException('LDAP: unknown binding type in: ' . __METHOD__);
        }
        
        if (!@ldap_bind($this->lh, $user, $pass)) {
            throw new ilLDAPQueryException('LDAP: Cannot bind as ' . $user . ' with message: ' . ldap_err2str(ldap_errno($this->lh)) . ' Trying fallback...', ldap_errno($this->lh));
        } else {
            $this->log->debug('Bind successful.');
        }
    }
    
    private function fetchUserProfileFields()
    {
        include_once('Services/LDAP/classes/class.ilLDAPRoleAssignmentRules.php');
        
        $this->user_fields = array_merge(
            array($this->settings->getUserAttribute()),
            array('dn'),
            $this->mapping->getFields(),
            ilLDAPRoleAssignmentRules::getAttributeNames($this->getServer()->getServerId())
        );
    }
    
    
    private function unbind()
    {
        if ($this->lh) {
            @ldap_unbind($this->lh);
        }
    }
    
    
    public function __destruct()
    {
        if ($this->lh) {
            @ldap_unbind($this->lh);
        }
    }

    public function checkPaginationEnabled() : bool
    {
        if ($this->getServer()->getVersion() != 3) {
            $this->log->info('Pagination control unavailable for ldap v' . $this->getServer()->getVersion());
            return false;
        }

        $result = ldap_read($this->lh, '', '(objectClass=*)', [self::IL_LDAP_SUPPORTED_CONTROL]);
        if ($result === false) {
            $this->log->warning('Failed to query for pagination control');
            return false;
        }
        $entries = (array) (ldap_get_entries($this->lh, $result)[0] ?? []);
        if (
            array_key_exists(strtolower(self::IL_LDAP_SUPPORTED_CONTROL), $entries) &&
            is_array($entries[strtolower(self::IL_LDAP_SUPPORTED_CONTROL)]) &&
            in_array(self::IL_LDAP_CONTROL_PAGEDRESULTS, $entries[strtolower(self::IL_LDAP_SUPPORTED_CONTROL)])
        ) {
            $this->log->info('Using paged control');
            return true;
        }
        $this->log->info('Paged control disabled');
        return false;
    }
}

function referralRebind($a_ds, $a_url)
{
    global $DIC;

    $ilLog = $DIC['ilLog'];
    
    $ilLog->write('LDAP: Called referralRebind.');
    
    ldap_set_option($a_ds, LDAP_OPT_PROTOCOL_VERSION, 3);
    
    if (!ldap_bind($a_ds, IL_LDAP_REBIND_USER, IL_LDAP_REBIND_PASS)) {
        $ilLog->write('LDAP: Rebind failed');
    }
}