ldap_set_option

(PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8)

ldap_set_option — Setzt den Wert der gegebenen Option

Beschreibung

ldap_set_option(?LDAP\Connection $ldap, int $option, array|string|int|bool $value): bool

Setzt den Wert der angegebenen Option auf value.

Parameter-Liste

ldap

Entweder eine von ldap_connect() zurückgegebene LDAP\Connection-Instanz, um die Option für diese Verbindung zu setzen, oder null, um die Option global zu setzen.

option

Der Parameter option kann einer der folgenden Werte sein:

Option	Typ	Verfügbar seit
`LDAP_OPT_DEREF`	int
`LDAP_OPT_SIZELIMIT`	int
`LDAP_OPT_TIMELIMIT`	int
`LDAP_OPT_NETWORK_TIMEOUT`	int
`LDAP_OPT_PROTOCOL_VERSION`	int
`LDAP_OPT_ERROR_NUMBER`	int
`LDAP_OPT_REFERRALS`	bool
`LDAP_OPT_RESTART`	bool
`LDAP_OPT_HOST_NAME`	string
`LDAP_OPT_ERROR_STRING`	string
`LDAP_OPT_DIAGNOSTIC_MESSAGE`	string
`LDAP_OPT_MATCHED_DN`	string
`LDAP_OPT_SERVER_CONTROLS`	array
`LDAP_OPT_CLIENT_CONTROLS`	array
`LDAP_OPT_X_KEEPALIVE_IDLE`	int	PHP 7.1.0
`LDAP_OPT_X_KEEPALIVE_PROBES`	int	PHP 7.1.0
`LDAP_OPT_X_KEEPALIVE_INTERVAL`	int	PHP 7.1.0
`LDAP_OPT_X_TLS_CACERTDIR`	string	PHP 7.1.0
`LDAP_OPT_X_TLS_CACERTFILE`	string	PHP 7.1.0
`LDAP_OPT_X_TLS_CERTFILE`	string	PHP 7.1.0
`LDAP_OPT_X_TLS_CIPHER_SUITE`	string	PHP 7.1.0
`LDAP_OPT_X_TLS_CRLCHECK`	int	PHP 7.1.0
`LDAP_OPT_X_TLS_CRLFILE`	string	PHP 7.1.0
`LDAP_OPT_X_TLS_DHFILE`	string	PHP 7.1.0
`LDAP_OPT_X_TLS_KEYFILE`	string	PHP 7.1.0
`LDAP_OPT_X_TLS_PROTOCOL_MIN`	int	PHP 7.1.0
`LDAP_OPT_X_TLS_RANDOM_FILE`	string	PHP 7.1.0
`LDAP_OPT_X_TLS_REQUIRE_CERT`	int	PHP 7.0.5

Die Optionen LDAP_OPT_SERVER_CONTROLS und LDAP_OPT_CLIENT_CONTROLS benötigen eine Liste von Steuerelementen, d. h. der Wert muss ein Array aus Steuerelementen sein. Ein Steuerelement besteht aus einer OID, die das Steuerelement identifiziert, einem optionalen Wert, und einem optionalen Kennzeichen für die Kritikalität. Bei PHP wird ein Steuerelement durch ein Array angegeben. Dieses Array enthält ein Element mit dem Schlüssel oid und einer Zeichenkette als Wert und zwei optionale Elemente. Die optionalen Elemente sind die Schlüssel value mit einer Zeichenkette als Wert und iscritical mit einem booleschen Wert. Der vorgegebene Wert von iscritical ist false, falls nicht angegeben. Siehe » draft-ietf-ldapext-ldap-c-api-xx.txt für Details. Ebenso ist das zweite Beispiel weiter unten zu konsultieren.

value

Der neue Wert für die angegebene option.

Rückgabewerte

Gibt bei Erfolg true zurück. Bei einem Fehler wird false zurückgegeben.

Changelog

Version	Beschreibung
8.1.0	Der Parameter `ldap` erwartet nun eine LDAP\Connection-Instanz; vorher wurde eine gültige `ldap link`-Ressource erwartet.

Beispiele

Beispiel #1 Setzen der Protokollversion

<?php
// $ds ist eine gültige LDAP\Connection-Instanz für einen Verzeichnis-Server
if (ldap_set_option($ds, LDAP_OPT_PROTOCOL_VERSION, 3))
    echo "Verwenden von LDAPv3";
} else {
    echo "Kann das Protokoll nicht auf Version 3 setzen";
}
?>

Beispiel #2 Setzen der Server-Steuerelemente

<?php
// $ds ist eine gültige LDAP\Connection-Instanz für einen Verzeichnis-Server
// Steuerelement ohne Wert
$ctrl1 = array("oid" => "1.2.752.58.10.1", "iscritical" => true);
// iscritical hat den vorgegebenen Wert FALSE
$ctrl2 = array("oid" => "1.2.752.58.1.10", "value" => "magic");
// Versuch, beide Steuerelemente zu setzen
if (!ldap_set_option($ds, LDAP_OPT_SERVER_CONTROLS, array($ctrl1, $ctrl2))) {
    echo "Kann die Server-Steuerelemente nicht setzen";
}
?>

Anmerkungen

Hinweis:
Diese Funktion steht nur zur Verfügung, wenn OpenLDAP 2.x.x ODER Netscape Directory SDK x.x verwendet wird.

Siehe auch

ldap_get_option() - Liefert den aktuellen Wert einer gegebenen Option

Improve This Page

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 8 notes

down

soulbros at yahoo dot com ¶

22 years ago

As john.hallam@compaq.com above mentioned ,one  has to set option LDAP_OPT_PROTOCOL_VERSION=3
ldap_set_option($ds,LDAP_OPT_PROTOCOL_VERSION,3);
to use the ldap_rename function.

However, the ldap_set_option() line has to be written immediately after ldap_connect() and before ldap_bind() statements.

Christos Soulios

down

hansfn at gmail dot com ¶

18 years ago

Luckily you can turn on debugging before you open a connection:

  ldap_set_option(NULL, LDAP_OPT_DEBUG_LEVEL, 7);

This way you at least can see in the logs if the connection fails...

down

php at richardneill dot org ¶

2 years ago

If you want to disable the TLS cert check (e.g. because you are doing an SSH port-forward, and ldaps is pointing to localhost), then you must invoke:

ldap_set_option(NULL, LDAP_OPT_X_TLS_REQUIRE_CERT,0)
*before* calling ldap_connect()

If you try: 

$ds = ldap_connect(...)
ldap_set_option($ds, LDAP_OPT_X_TLS_REQUIRE_CERT,0)

then the option won't actually take effect, and the certificate will be checked anyway, and a TLS failure will happen..

down

technosophos ¶

17 years ago

The following flags are valid integer values for the LDAP_OPT_DEREF (as taken from the documentation for ldap_read()):

LDAP_DEREF_NEVER (int 0) - (default) aliases are never dereferenced.

LDAP_DEREF_SEARCHING (int 1) - aliases should be dereferenced during the search but not when locating the base object of the search.

LDAP_DEREF_FINDING (int 2) - aliases should be dereferenced when locating the base object but not during the search.

LDAP_DEREF_ALWAYS (int 3) - aliases should be dereferenced always.

Example:
<?php
ldap_set_option($ds, LDAP_OPT_DEREF, LDAP_DEREF_ALWAYS);
?> 

These are defined in the draft C API (presumably from the original LDAP API). See draft-ietf-ldapext-ldap-c-api-xx.txt included in the OpenLDAP source code distribution.

down

Maarten at Aerobe ¶

4 years ago

PHP 7.1 added support for configuring the LDAP CA/Cert environment directly, rather than relying on the environment variables. I noticed that a lot of people are having trouble getting this to work.

The correct way is:
$ds=ldap_connect("ldap.google.com");  
ldap_set_option(NULL, LDAP_OPT_X_TLS_CERTFILE, "/path/file.crt");
ldap_set_option(NULL, LDAP_OPT_X_TLS_KEYFILE, "/path/file.key");
ldap_set_option($ds, LDAP_OPT_PROTOCOL_VERSION, 3);
ldap_set_option($ds, LDAP_OPT_REFERRALS, 0);
ldap_start_tls($ds);
...
ldap_close($ds);

down

badbo_5834 at hotmail dot com ¶

10 years ago

I have the following code, but you do not rename the cn, that may be?

    $TheDN = "cn=Nombre,ou=Addressbook,dc=axia-ldap,dc=net";
    $newRDN = "cn=bill";
    $newParent = "ou=Addressbook,dc=axia-ldap,dc=net";
    ldap_set_option($ds,LDAP_OPT_PROTOCOL_VERSION,3);
    $result = ldap_rename($ds, $TheDN, $newRDN, $newParent, TRUE);

down

john dot hallam at compaq dot com ¶

22 years ago

To get this to work I had to set the LDAP version to 3 using ldap_set_option. Here is an example that might help:

$TheDN = "cn=john smith,ou=users,dc=acme,dc=com";
$newRDN = "cn=bill brown";
$newParent = "ou=users,dc=acme,dc=com";
ldap_set_option($ds,LDAP_OPT_PROTOCOL_VERSION,3);
@$result = ldap_rename($ds, $TheDN, $newRDN, $newParent, TRUE);

down

-2

minusf at gmail dot com ¶

19 years ago

it seems that ldap_set_option returns 1 for bogus ldap_connect -ions also.
ldap_connect always returns a resource (documented in the
comments of ldap_connect) so it is not possible to check if the
ldap server is there or alive or what.  and because ldap_set_option
must be between ldap_connect and ldap_bind, there seems to
be no sense in checking the return value.

it is a bit strange that ldap_bind is the first function which can
really check if a ldap resource is usable because it is the third
function in line to use when working with openldap.

<?php
$connect = ldap_connect("whatever");
$set = ldap_set_option($connect, LDAP_OPT_PROTOCOL_VERSION, 3);
echo $set;
?>

＋add a note