rfc:ldap_exop
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
rfc:ldap_exop [2017/06/26 14:53] – Added functions definitions mcmic | rfc:ldap_exop [2017/06/26 15:22] – mcmic | ||
---|---|---|---|
Line 17: | Line 17: | ||
===== New functions ===== | ===== New functions ===== | ||
+ | In all these functions $link should be a valid LDAP connection object with a user bound to it already. | ||
<code php> | <code php> | ||
mixed ldap_exop(resource $link, string $reqoid [, string $reqdata [, string & | mixed ldap_exop(resource $link, string $reqoid [, string $reqdata [, string & | ||
</ | </ | ||
- | Returns FALSE upon failure, TRUE upon success if $retoid is provided, and a result object otherwise (success with 3 params or less). | + | Returns FALSE upon failure, TRUE upon success if $retoid is provided, and a result object otherwise (success with 3 params or less). Either fills $retoid and $retdata or returns a result object. |
<code php> | <code php> | ||
bool ldap_parse_exop(resource $link, resource $result [, string & | bool ldap_parse_exop(resource $link, resource $result [, string & | ||
</ | </ | ||
Returns TRUE upon success and FALSE upon failure. Fills $retoid and $retdata with the data from $result object. | Returns TRUE upon success and FALSE upon failure. Fills $retoid and $retdata with the data from $result object. | ||
+ | |||
+ | This RFC also wish to introduce helper functions for common EXOP usage: | ||
+ | <code php> | ||
+ | mixed ldap_exop_whoami(resource $link) | ||
+ | bool ldap_exop_passwd(resource $link, string $user, string $oldpw, string $newpw [, string & | ||
+ | </ | ||
+ | The first one would call whoami EXOP and return either the result or FALSE upon failure. | ||
+ | The second one would call passwd EXOP and return TRUE or FALSE upon failure. If $newpw is empty, $genpw will be filled with the generated password for the user. If $user is empty, it affects the bound user. | ||
+ | |||
+ | The author of the original patch stated that technically ldap_start_tls is an exop helper and therefore could be renamed ldap_exop_start_tls. We fill this would be a useless BC. | ||
+ | |||
+ | The original patch (and current code) provided a possibility to get a result object from helpers as well, and provided ldap_parse_exop_* helpers to parse the result objects from these operations. We fill this is too complex and does not add anything to the RFC so we intend to leave them out. | ||
+ | |||
+ | ===== Examples ===== | ||
+ | <code php> | ||
+ | // Call EXOP whoami and store the result in $identity | ||
+ | if (ldap_exop($link, | ||
+ | echo " | ||
+ | } else { | ||
+ | echo " | ||
+ | } | ||
+ | // Same thing using a result object | ||
+ | $r = ldap_exop($link, | ||
+ | if (($r !== FALSE) && ldap_parse_exop($link, | ||
+ | echo " | ||
+ | } else { | ||
+ | echo " | ||
+ | } | ||
+ | // Same thing with the helper | ||
+ | $identity = ldap_exop_whoami($link); | ||
+ | if ($identity !== FALSE) { | ||
+ | echo " | ||
+ | } else { | ||
+ | echo " | ||
+ | } | ||
+ | // Changing password with the helper | ||
+ | if (ldap_exop_passwd($link, | ||
+ | echo " | ||
+ | } else { | ||
+ | echo " | ||
+ | } | ||
+ | </ | ||
===== Backward Incompatible Changes ===== | ===== Backward Incompatible Changes ===== | ||
Line 30: | Line 73: | ||
===== Proposed PHP Version(s) ===== | ===== Proposed PHP Version(s) ===== | ||
- | 7.2 if possible, 7.3/8 otherwise | + | Next PHP 7.x release |
===== RFC Impact ===== | ===== RFC Impact ===== | ||
Line 50: | Line 93: | ||
- Should the function names contain the word " | - Should the function names contain the word " | ||
- Should we include a constant for LDAP_EXOP_REFRESH, | - Should we include a constant for LDAP_EXOP_REFRESH, | ||
+ | - Should helper functions return a mixed, or a boolean and have an out parameter? (" | ||
+ | - How would someone go about generating the needed ber-encoded data to pass ldap_exop in PHP? Should this RFC also define functions to handle ber-encoded data? | ||
===== Unaffected PHP Functionality ===== | ===== Unaffected PHP Functionality ===== |
rfc/ldap_exop.txt · Last modified: 2017/09/22 13:28 by 127.0.0.1