ldap_exop_passwd

PASSWD extended operation helper

&reftitle.description; ``string``bool```ldap_exop_passwd` `LDAP\Connection` `ldap` `string` `user`"" #[\SensitiveParameter]`string` `old_password`"" #[\SensitiveParameter]`string` `new_password`"" `array` `controls`&null;

Performs a PASSWD extended operation.

&reftitle.parameters;

`ldap`

- &ldap.parameter.ldap;

`user`

- dn of the user to change the password of.

`old_password`

- The old password of this user. May be ommited depending of server configuration.

`new_password`

- The new password for this user. May be omitted or empty to have a generated password.

`controls`

- If provided, a password policy request control is send with the request and this is filled with an array of LDAP Controls returned with the request.

&reftitle.returnvalues;

Returns the generated password if `new_password` is empty or omitted. Otherwise returns &true; on success and &false; on failure.

&reftitle.changelog;

&Version; | &Description;
&ldap.changelog.ldap-object; &ldap.changelog.controls-nullable;
7.3.0 | Support for `controls` added

&reftitle.examples;

### PASSWD extended operation

    <?php
    $ds = ldap_connect("localhost");  // assuming the LDAP server is on this host

    if ($ds) {
        // bind with appropriate dn to give update access
        $bind = ldap_bind($ds, "cn=root, o=My Company, c=US", "secret");
        if (!$bind) {
          echo "Unable to bind to LDAP server";
          exit;
        }

        // use PASSWD EXOP to change the user password for a generated one
        $genpw = ldap_exop_passwd($ds, "cn=root, o=My Company, c=US", "secret");
        if ($genpw) {
          // use the generated password to bind
          $bind = ldap_bind($ds, "cn=root, o=My Company, c=US", $genpw);
        }

        // set the password back to "secret"
        ldap_exop_passwd($ds, "cn=root, o=My Company, c=US", $genpw, "secret");

        ldap_close($ds);
    } else {
        echo "Unable to connect to LDAP server";
    }
    ?>

&reftitle.seealso;

- `ldap_exop`
- `ldap_parse_exop`