.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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::Control::PasswordPolicy 3pm"
.TH Net::LDAP::Control::PasswordPolicy 3pm "2021-01-03" "perl v5.32.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::Control::PasswordPolicy \- LDAPv3 Password Policy control object
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\& use Net::LDAP;
\& use Net::LDAP::Control::PasswordPolicy;
\& use Net::LDAP::Constant qw( LDAP_CONTROL_PASSWORDPOLICY );
\&
\& $ldap = Net::LDAP\->new( "ldap.example.com" );
\&
\& $pp = Net::LDAP::Control::PasswordPolicy\->new;
\&
\& $mesg = $ldap\->bind( "cn=Bob Smith,dc=example,dc=com",
\&                      password => "secret",
\&                      control => [ $pp ] );
\&
\& # Get password policy response
\& my($resp)  = $mesg\->control( LDAP_CONTROL_PASSWORDPOLICY );
\&
\& if (defined($resp)) {
\&   my $v = $resp\->pp_error;
\&   print "Password policy error $v\en"  if defined $v;
\&   $v = $resp\->time_before_expiration;
\&   print "Password expires in $v second(s)\en"  if defined $v;
\& }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`Net::LDAP::Control::PasswordPolicy\*(C'\fR provides an interface for the
creation and manipulation of objects that represent
\&\f(CW\*(C`PasswordPolicyRequest\*(C'\fRs and \f(CW\*(C`PasswordPolicyResponse\*(C'\fRs as described by
draft\-behera\-password\-policy\-09.
.PP
This control can be passed to most operations, including the bind.
.SH "CONSTRUCTOR ARGUMENTS"
.IX Header "CONSTRUCTOR ARGUMENTS"
There are no constructor arguments other than those provided by
Net::LDAP::Control.
.SH "METHODS"
.IX Header "METHODS"
.IP "time_before_expiration" 4
.IX Item "time_before_expiration"
If defined, this is an integer value holding the time left in seconds
before the account's password will expire.
.IP "grace_authentications_remaining" 4
.IX Item "grace_authentications_remaining"
If defined, this is an integer value holding the number of
authentication requests allowed before the account is locked.
.IP "pp_error" 4
.IX Item "pp_error"
If defined, this contains a more detailed error code for the account.
See Net::LDAP::Constant for definitions of each.
Values can include:
.RS 4
.IP "\s-1LDAP_PP_PASSWORD_EXPIRED\s0" 4
.IX Item "LDAP_PP_PASSWORD_EXPIRED"
.PD 0
.IP "\s-1LDAP_PP_ACCOUNT_LOCKED\s0" 4
.IX Item "LDAP_PP_ACCOUNT_LOCKED"
.IP "\s-1LDAP_PP_CHANGE_AFTER_RESET\s0" 4
.IX Item "LDAP_PP_CHANGE_AFTER_RESET"
.IP "\s-1LDAP_PP_PASSWORD_MOD_NOT_ALLOWED\s0" 4
.IX Item "LDAP_PP_PASSWORD_MOD_NOT_ALLOWED"
.IP "\s-1LDAP_PP_MUST_SUPPLY_OLD_PASSWORD\s0" 4
.IX Item "LDAP_PP_MUST_SUPPLY_OLD_PASSWORD"
.IP "\s-1LDAP_PP_INSUFFICIENT_PASSWORD_QUALITY\s0" 4
.IX Item "LDAP_PP_INSUFFICIENT_PASSWORD_QUALITY"
.IP "\s-1LDAP_PP_PASSWORD_TOO_SHORT\s0" 4
.IX Item "LDAP_PP_PASSWORD_TOO_SHORT"
.IP "\s-1LDAP_PP_PASSWORD_TOO_YOUNG\s0" 4
.IX Item "LDAP_PP_PASSWORD_TOO_YOUNG"
.IP "\s-1LDAP_PP_PASSWORD_IN_HISTORY\s0" 4
.IX Item "LDAP_PP_PASSWORD_IN_HISTORY"
.RE
.RS 4
.RE
.PD
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Net::LDAP,
Net::LDAP::Control,
Net::LDAP::Constant,
draft\-behera\-ldap\-password\-policy\-09.txt
.SH "AUTHOR"
.IX Header "AUTHOR"
Chris Ridd <chris.ridd@isode.com>
.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) 2008 Chris Ridd. All rights reserved. This program is
free software; you can redistribute it and/or modify it under the same
terms as Perl itself.