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:44] – mcmic | rfc:ldap_exop [2017/07/04 07:52] – mcmic | ||
---|---|---|---|
Line 15: | Line 15: | ||
This RFC intends to add support for EXOP in php-ldap. | This RFC intends to add support for EXOP in php-ldap. | ||
It is based on a patch for php-ldap which is more than 10 years old and we are trying to adapt it for current code base. | It is based on a patch for php-ldap which is more than 10 years old and we are trying to adapt it for current code base. | ||
+ | |||
+ | ===== New functions ===== | ||
+ | In all these functions $link should be a valid LDAP connection object with a user bound to it already. | ||
+ | <code php> | ||
+ | mixed ldap_exop(resource $link, string $reqoid [, string $reqdata [, string & | ||
+ | </ | ||
+ | Returns FALSE upon failure, TRUE upon success if $retdata 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> | ||
+ | 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. | ||
+ | |||
+ | Note that $retoid is useless in most cases, EXOPs usually leave it empty or fill it with $reqoid. This is why it’s in last position. | ||
+ | |||
+ | This RFC also wish to introduce helper functions for common EXOP usage: | ||
+ | <code php> | ||
+ | bool|string ldap_exop_whoami(resource $link) | ||
+ | bool|string ldap_exop_passwd(resource $link, [string $user, [string $oldpw, [string $newpw]]]) | ||
+ | </ | ||
+ | The first one would call whoami EXOP and returns the result. Returns FALSE upon failure. | ||
+ | The second one would call passwd EXOP and return TRUE or FALSE upon failure. If $newpw is empty, returns 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 feel 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 feel this is too complex and does not add anything to the RFC so we intend to leave them out. | ||
+ | |||
+ | For consistency with existing ldap functions, theses function may produce E_WARNING in case of error or failure. | ||
+ | The safe way to use them is to use @ when calling them. ldap_error() can be used to get the last LDAP error in cases where it makes sense. | ||
+ | |||
+ | ===== 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 | ||
+ | if (ldap_exop_whoami($link, | ||
+ | echo " | ||
+ | } else { | ||
+ | echo " | ||
+ | } | ||
+ | // Changing password with the helper | ||
+ | if (ldap_exop_passwd($link, | ||
+ | echo " | ||
+ | } else { | ||
+ | echo " | ||
+ | } | ||
+ | </ | ||
===== Backward Incompatible Changes ===== | ===== Backward Incompatible Changes ===== | ||
Line 20: | Line 77: | ||
===== 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 ===== | ||
==== To SAPIs ==== | ==== To SAPIs ==== | ||
- | Describe the impact | + | No impact |
==== To Existing Extensions ==== | ==== To Existing Extensions ==== | ||
Line 39: | Line 96: | ||
===== Open Issues ===== | ===== Open Issues ===== | ||
- Should the function names contain the word " | - Should the function names contain the word " | ||
- | - Should we include a constant for LDAP_EXOP_REFRESH, for the sake of completeness, | + | - Should we include a constant for LDAP_EXOP_CANCEL, for the sake of completeness, |
===== Unaffected PHP Functionality ===== | ===== Unaffected PHP Functionality ===== | ||
Line 68: | Line 125: | ||
===== Rejected Features ===== | ===== Rejected Features ===== | ||
+ | None |
rfc/ldap_exop.txt · Last modified: 2017/09/22 13:28 by 127.0.0.1