.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Net::LDAP::Extension::SetPassword 3"
.TH Net::LDAP::Extension::SetPassword 3 2024-09-01 "perl v5.40.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Net::LDAP::Extension::SetPassword \- LDAPv3 Modify Password extension object
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\& use Net::LDAP;
\& use Net::LDAP::Extension::SetPassword;
\&
\& $ldap = Net::LDAP\->new( "ldap.mydomain.eg" );
\&
\& $ldap\->bind(\*(Aqcn=Joe User,cn=People,dc=mydomain,dc=eg",
\&             password => \*(AqoldPassword\*(Aq);
\&
\& $mesg = $ldap\->set_password( oldpasswd => \*(AqoldPassword\*(Aq );
\&
\& die "error: ", $mesg\->code(), ": ", $mesg\->error()  if ($mesg\->code());
\&
\& print "changed your password to", $mesg\->gen_password() , "\en";
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\f(CW\*(C`Net::LDAP::Extension::SetPassword\*(C'\fR implements the \f(CW\*(C`Modify Password\*(C'\fR
extended LDAPv3 operation as described in RFC 3062.
.PP
It implements no object by itself but extends the Net::LDAP object
by another method:
.SH METHODS
.IX Header "METHODS"
.IP "set_password ( OPTIONS )" 4
.IX Item "set_password ( OPTIONS )"
Set the password for a user.
.Sp
OPTIONS is a list of key/value pairs. The following keys are recognized:
.RS 4
.IP user 4
.IX Item "user"
If present, this option contains the octet string representation of the
user associated with the request.  Depending on how users are identified
in the directory this string may or may not be a DN according to RFC 4514.
.Sp
If this option is not present, the request acts up upon the password
of the user currently associated with the LDAP session.
.IP oldpasswd 4
.IX Item "oldpasswd"
This option, if present, must contain the current password of the user
for whom this operation is performed.
.Sp
It depends on the server's implementation in which circumstances this
option is allowed to be missing.
.IP newpasswd 4
.IX Item "newpasswd"
If present, this option contains the desired password for the user for
whom the operation is performed.
.Sp
Depending on the server's implementation this option may be required by
the LDAP server.
.RE
.RS 4
.RE
.IP "gen_password ( )" 4
.IX Item "gen_password ( )"
Return the password generated by the server in response to the
\&\f(CWset_password()\fR call when applicable. The server will not generate
a new password if \f(CW\*(C`newpasswd\*(C'\fR was passed to \f(CWset_password()\fR.
.Sp
This method is a method of the Net::LDAP::Message response object
returned in reply to \f(CWset_password()\fR in case the \f(CWset_password()\fR
call succeeded.
.Sp
By this method the caller can query for the value of the password in
case he did not call \f(CWset_password()\fR with the \f(CW\*(C`newpasswd\*(C'\fR option.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Net::LDAP,
Net::LDAP::Extension
.SH AUTHOR
.IX Header "AUTHOR"
Graham Barr <gbarr@pobox.com>,
documentation by Peter Marschall <peter@adpm.de>.
.PP
Please report any bugs, or post any suggestions, to the perl-ldap
mailing list <perl\-ldap@perl.org>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (c) 2002\-2004 Graham Barr. All rights reserved. This program is
free software; you can redistribute it and/or modify it under the same
terms as Perl itself.