ldap_set_option - PHP code example

PHP Function LDAP_Set_Option

The php function ldap_set_option lets you set the value of an option. You can pass it a single option, an array of options, or even an LDAPConnection instance (which sets the option for that connection). The LDAP_OPT_DEREF, LDAP_OPT_SIZELIMIT, and LDAP_OPT_PROTOCOL_VERSION options have integer values, the LDAP_OPT_HOSTNAME and LDAP_OPT_MATCHED_DN options have string values, and the LDAP_OPT_IS_CRITICAL option has a boolean value.

A new feature added to PHP 7.3 that simplifies JSON error handling is the ability to pass in a flag called JSON_THROW_ON_ERROR, which will cause the function to throw a JsonException whenever the error code returned by the json_encode() or json_decode() functions is not JSON_ERROR_NONE. PHP 7.3 also added support for samesite cookies, improved FastCGI Process Manager (php-fpm) logging, expanded LDAP controls, and provided case-mapping and case-folding support in mbstring functions.

Many LDAP server implementations require that you specify which LDAP protocol version to use, especially since LDAPv2 has been declared historical and deprecated and LDAPv3 is now the only viable option (LDAPv3 is also backwards-compatible with LDAPv2). This can be accomplished by using ldap_set_option(). In this article we will show how to use this function and a couple of other related functions in order to connect, bind, and then read entries from the LDAP directory server. We will also demonstrate how to intercept the LDAP query via Burpsuite and check whether the password was reset correctly.

ldap_set_option example

        // the we support.         //         // This is not supported in PHP < 7.2, so these versions will remain broken.         $ctl = [];
        ldap_get_option($con, \LDAP_OPT_SERVER_CONTROLS, $ctl);
        if (!empty($ctl)) {
            foreach ($ctl as $idx => $info) {
                if (static::PAGINATION_OID == $info['oid']) {
                    unset($ctl[$idx]);
                }
            }
            ldap_set_option($con, \LDAP_OPT_SERVER_CONTROLS, $ctl);
        }
    }

    /** * Sets LDAP pagination controls. */
    private function controlPagedResult(int $pageSize, bool $critical, string $cookie): bool
    {
        $this->serverctrls = [
            [
                'oid' => \LDAP_CONTROL_PAGEDRESULTS,

namespace Symfony\Component\Ldap\Tests;

use PHPUnit\Framework\TestCase;

class LdapTestCase extends TestCase
{
    protected function getLdapConfig()
    {
        $h = @ldap_connect(getenv('LDAP_HOST'), getenv('LDAP_PORT'));
        @ldap_set_option($h, \LDAP_OPT_PROTOCOL_VERSION, 3);

        if (!$h || !@ldap_bind($h)) {
            $this->markTestSkipped('No server is listening on LDAP_HOST:LDAP_PORT');
        }

        ldap_unbind($h);

        return [
            'host' => getenv('LDAP_HOST'),
            'port' => getenv('LDAP_PORT'),
        ];
    }

    public function getResource(): ?LDAPConnection
    {
        return $this->connection;
    }

    /** * @return void */
    public function setOption(string $name, array|string|int|bool $value)
    {
        if (!@ldap_set_option($this->connection, ConnectionOptions::getOption($name), $value)) {
            throw new LdapException(sprintf('Could not set value "%s" for option "%s".', $value, $name));
        }
    }

    /** * @return array|string|int|null */
    public function getOption(string $name)
    {
        if (!@ldap_get_option($this->connection, ConnectionOptions::getOption($name), $ret)) {
            throw new LdapException(sprintf('Could not retrieve value for option "%s".', $name));
        }